PageRenderTime 126ms CodeModel.GetById 17ms RepoModel.GetById 0ms app.codeStats 2ms

/test/schema/paypal/eBLBaseComponents.xsd

https://github.com/plusplus/active_merchant
XML Schema | 14402 lines | 14366 code | 36 blank | 0 comment | 0 complexity | 772767e6b44265fc82dacf967be3dfd5 MD5 | raw file
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <schema xmlns="http://www.w3.org/2001/XMLSchema" xmlns:cc="urn:ebay:apis:CoreComponentTypes" xmlns:ns="urn:ebay:apis:eBLBaseComponents" xmlns:ed="urn:ebay:apis:EnhancedDataTypes" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="urn:ebay:apis:eBLBaseComponents" elementFormDefault="qualified" attributeFormDefault="unqualified">
  3. <import namespace="urn:ebay:apis:CoreComponentTypes" schemaLocation="test/schema/paypal/CoreComponentTypes.xsd"/>
  4. <import namespace="urn:ebay:apis:EnhancedDataTypes" schemaLocation="test/schema/paypal/EnhancedDataTypes.xsd"/>
  5. <simpleType name="AccountStateCodeType">
  6. <annotation>
  7. <documentation>
  8. AccountStateCodeType
  9. These are the possible codes to describe the state of an account of an
  10. eBay user.
  11. </documentation>
  12. </annotation>
  13. <restriction base="xs:token">
  14. <enumeration value="Active">
  15. <annotation>
  16. <documentation>
  17. Amex
  18. </documentation>
  19. </annotation>
  20. </enumeration>
  21. <enumeration value="Pending">
  22. <annotation>
  23. <documentation>
  24. Visa
  25. </documentation>
  26. </annotation>
  27. </enumeration>
  28. <enumeration value="Inactive">
  29. <annotation>
  30. <documentation>
  31. Mastercard
  32. </documentation>
  33. </annotation>
  34. </enumeration>
  35. <enumeration value="CustomCode">
  36. <annotation>
  37. <documentation>
  38. Reserved for internal or future use.
  39. </documentation>
  40. </annotation>
  41. </enumeration>
  42. </restriction>
  43. </simpleType>
  44. <simpleType name="AckCodeType">
  45. <annotation>
  46. <documentation>
  47. AckCodeType
  48. This code identifies the acknowledgement code types that
  49. could be used to communicate the status of processing a
  50. (request) message to an application. This code would be used
  51. as part of a response message that contains an application
  52. level acknowledgement element.
  53. </documentation>
  54. </annotation>
  55. <restriction base="xs:token">
  56. <enumeration value="Success">
  57. <annotation>
  58. <documentation>
  59. Request processing succeeded.
  60. </documentation>
  61. </annotation>
  62. </enumeration>
  63. <enumeration value="Failure">
  64. <annotation>
  65. <documentation>
  66. Request processing failed.
  67. </documentation>
  68. </annotation>
  69. </enumeration>
  70. <enumeration value="Warning">
  71. <annotation>
  72. <documentation>
  73. Request processing completed with warning information
  74. being included in the response message.
  75. </documentation>
  76. </annotation>
  77. </enumeration>
  78. <enumeration value="SuccessWithWarning">
  79. <annotation>
  80. <documentation>
  81. Request processing completed successful with some
  82. with some warning information that could be useful for
  83. the requesting application to process and/or record.
  84. </documentation>
  85. </annotation>
  86. </enumeration>
  87. <enumeration value="FailureWithWarning">
  88. <annotation>
  89. <documentation>
  90. Request processing failed with some error and warnining
  91. information that requesting application should process to
  92. determine cause(s) of failure.
  93. </documentation>
  94. </annotation>
  95. </enumeration>
  96. <enumeration value="PartialSuccess">
  97. <annotation>
  98. <documentation>
  99. Request processing completed with Partial Success.
  100. </documentation>
  101. </annotation>
  102. </enumeration>
  103. <enumeration value="CustomCode">
  104. <annotation>
  105. <documentation>
  106. Reserved for internal or future use.
  107. </documentation>
  108. </annotation>
  109. </enumeration>
  110. </restriction>
  111. </simpleType>
  112. <simpleType name="AddressOwnerCodeType">
  113. <annotation>
  114. <documentation>
  115. AddressOwnerCodeType
  116. This code identifies the AddressOwner code types which indicates
  117. who owns the user'a address.
  118. </documentation>
  119. </annotation>
  120. <restriction base="xs:token">
  121. <enumeration value="PayPal">
  122. <annotation>
  123. <documentation>
  124. PayPal owns address.
  125. </documentation>
  126. </annotation>
  127. </enumeration>
  128. <enumeration value="eBay">
  129. <annotation>
  130. <documentation>
  131. eBay owns address.
  132. </documentation>
  133. </annotation>
  134. </enumeration>
  135. <enumeration value="CustomCode">
  136. <annotation>
  137. <documentation>
  138. Reserved for internal or future use.
  139. </documentation>
  140. </annotation>
  141. </enumeration>
  142. </restriction>
  143. </simpleType>
  144. <simpleType name="AuctionTypeCodeType">
  145. <annotation>
  146. <documentation>
  147. AuctionTypeCodeType - Type declaration to be used
  148. by other schema's. This includes codes indicating the
  149. type of auction for the listed item.
  150. </documentation>
  151. </annotation>
  152. <restriction base="xs:token">
  153. <enumeration value="Unknown">
  154. <annotation>
  155. <documentation>
  156. Unknown auction type
  157. </documentation>
  158. </annotation>
  159. </enumeration>
  160. <enumeration value="Chinese">
  161. <annotation>
  162. <documentation>
  163. Chinese auction
  164. </documentation>
  165. </annotation>
  166. </enumeration>
  167. <enumeration value="Dutch">
  168. <annotation>
  169. <documentation>
  170. Dutch auction
  171. </documentation>
  172. </annotation>
  173. </enumeration>
  174. <enumeration value="Live">
  175. <annotation>
  176. <documentation>
  177. Live Auctions-type auction
  178. </documentation>
  179. </annotation>
  180. </enumeration>
  181. <enumeration value="Ad type">
  182. <annotation>
  183. <documentation>
  184. Ad type auction
  185. </documentation>
  186. </annotation>
  187. </enumeration>
  188. <enumeration value="Stores Fixed-price">
  189. <annotation>
  190. <documentation>
  191. Stores Fixed-price auction (US only)
  192. </documentation>
  193. </annotation>
  194. </enumeration>
  195. <enumeration value="Personal Offer">
  196. <annotation>
  197. <documentation>
  198. Personal Offer auction
  199. </documentation>
  200. </annotation>
  201. </enumeration>
  202. <enumeration value="Fixed Price Item">
  203. <annotation>
  204. <documentation>
  205. Fixed Price item ("BIN only").
  206. </documentation>
  207. </annotation>
  208. </enumeration>
  209. <enumeration value="CustomCode">
  210. <annotation>
  211. <documentation>
  212. Reserved for internal or future use.
  213. </documentation>
  214. </annotation>
  215. </enumeration>
  216. </restriction>
  217. </simpleType>
  218. <simpleType name="BalanceCodeType">
  219. <annotation>
  220. <documentation>
  221. BalanceCodeType
  222. This code identifies the types of balances in an account, e.g., a PayPal
  223. account.
  224. </documentation>
  225. </annotation>
  226. <restriction base="xs:token">
  227. <enumeration value="Other">
  228. <annotation>
  229. <documentation>Custom Code</documentation>
  230. </annotation>
  231. </enumeration>
  232. <enumeration value="CustomCode">
  233. <annotation>
  234. <documentation>
  235. Reserved for internal or future use.
  236. </documentation>
  237. </annotation>
  238. </enumeration>
  239. </restriction>
  240. </simpleType>
  241. <simpleType name="BuyerPaymentMethodCodeType">
  242. <annotation>
  243. <documentation>
  244. BuyerPaymentMethodCodeType - Type declaration to be used
  245. by other schema. The includes the codes for payment methods
  246. used by buyers to pay sellers.
  247. </documentation>
  248. </annotation>
  249. <restriction base="xs:token">
  250. <enumeration value="None">
  251. <annotation>
  252. <documentation>
  253. No payment method specified
  254. </documentation>
  255. </annotation>
  256. </enumeration>
  257. <enumeration value="MOCC">
  258. <annotation>
  259. <documentation>
  260. Money order/cashiers check
  261. </documentation>
  262. </annotation>
  263. </enumeration>
  264. <enumeration value="AmEx">
  265. <annotation>
  266. <documentation>
  267. American Express
  268. </documentation>
  269. </annotation>
  270. </enumeration>
  271. <enumeration value="PaymentSeeDescription">
  272. <annotation>
  273. <documentation>
  274. Payment See Description
  275. </documentation>
  276. </annotation>
  277. </enumeration>
  278. <enumeration value="CCAccepted">
  279. <annotation>
  280. <documentation>
  281. American Express
  282. </documentation>
  283. </annotation>
  284. </enumeration>
  285. <enumeration value="PersonalCheck">
  286. <annotation>
  287. <documentation>
  288. Personal check
  289. </documentation>
  290. </annotation>
  291. </enumeration>
  292. <enumeration value="COD">
  293. <annotation>
  294. <documentation>
  295. COD
  296. </documentation>
  297. </annotation>
  298. </enumeration>
  299. <enumeration value="VisaMC">
  300. <annotation>
  301. <documentation>
  302. Visa/Mastercard
  303. </documentation>
  304. </annotation>
  305. </enumeration>
  306. <enumeration value="Other">
  307. <annotation>
  308. <documentation>
  309. Other forms of payment.
  310. Some custom method is accepted by seller
  311. as payment method in the transaction. For
  312. Motors vehicle items, this field refers to the
  313. Deposit payment method.
  314. </documentation>
  315. </annotation>
  316. </enumeration>
  317. <enumeration value="PayPal">
  318. <annotation>
  319. <documentation>
  320. PayPal
  321. </documentation>
  322. </annotation>
  323. </enumeration>
  324. <enumeration value="Discover">
  325. <annotation>
  326. <documentation>
  327. Discover
  328. </documentation>
  329. </annotation>
  330. </enumeration>
  331. <enumeration value="CashOnPickup">
  332. <annotation>
  333. <documentation>
  334. Payment on delivery acceptable payment term.
  335. </documentation>
  336. </annotation>
  337. </enumeration>
  338. <enumeration value="MoneyXferAccepted">
  339. <annotation>
  340. <documentation>
  341. Direct transfer of money acceptable payment term.
  342. </documentation>
  343. </annotation>
  344. </enumeration>
  345. <enumeration value="MoneyXferAcceptedinCheckout">
  346. <annotation>
  347. <documentation>
  348. If the seller has bank account information on file,
  349. and MoneyXferAcceptedinCheckout = true, then
  350. the bank account information will be displayed in
  351. Checkout. Applicable to German site only.
  352. </documentation>
  353. </annotation>
  354. </enumeration>
  355. <enumeration value="OtherOnlinePayments">
  356. <annotation>
  357. <documentation>
  358. Online Escrow paid for by seller.
  359. </documentation>
  360. </annotation>
  361. </enumeration>
  362. <enumeration value="CustomCode">
  363. <annotation>
  364. <documentation>
  365. Reserved for internal or future use.
  366. </documentation>
  367. </annotation>
  368. </enumeration>
  369. </restriction>
  370. </simpleType>
  371. <simpleType name="BuyerProtectionCodeType">
  372. <annotation>
  373. <documentation>
  374. BuyerProtectionCodeType
  375. </documentation>
  376. </annotation>
  377. <restriction base="xs:token">
  378. <enumeration value="ItemIneligible">
  379. <annotation>
  380. <documentation>
  381. Item is ineligible (e.g., category not applicable).
  382. </documentation>
  383. </annotation>
  384. </enumeration>
  385. <enumeration value="ItemEligible">
  386. <annotation>
  387. <documentation>
  388. Item is eligible per standard criteria.
  389. </documentation>
  390. </annotation>
  391. </enumeration>
  392. <enumeration value="ItemMarkedIneligible">
  393. <annotation>
  394. <documentation>
  395. Item marked ineligible per special criteria (e.g., seller's account closed).
  396. </documentation>
  397. </annotation>
  398. </enumeration>
  399. <enumeration value="ItemMarkedEligible">
  400. <annotation>
  401. <documentation>
  402. Item marked eligible per other criteria.
  403. </documentation>
  404. </annotation>
  405. </enumeration>
  406. <enumeration value="CustomCode">
  407. <annotation>
  408. <documentation>
  409. Reserved for internal or future use.
  410. </documentation>
  411. </annotation>
  412. </enumeration>
  413. </restriction>
  414. </simpleType>
  415. <simpleType name="CheckoutStatusCodeType">
  416. <annotation>
  417. <documentation>
  418. CheckoutStatusCodeType
  419. </documentation>
  420. </annotation>
  421. <restriction base="xs:token">
  422. <enumeration value="CheckoutComplete">
  423. <annotation>
  424. <documentation>
  425. Checkout complete.
  426. </documentation>
  427. </annotation>
  428. </enumeration>
  429. <enumeration value="CheckoutIncomplete">
  430. <annotation>
  431. <documentation>
  432. Checkout incomplete. No details specified.
  433. </documentation>
  434. </annotation>
  435. </enumeration>
  436. <enumeration value="BuyerRequestsTotal">
  437. <annotation>
  438. <documentation>
  439. Buyer requests total.
  440. </documentation>
  441. </annotation>
  442. </enumeration>
  443. <enumeration value="SellerResponded">
  444. <annotation>
  445. <documentation>
  446. Seller responded to buyer's request.
  447. </documentation>
  448. </annotation>
  449. </enumeration>
  450. <enumeration value="CustomCode">
  451. <annotation>
  452. <documentation>
  453. Reserved for internal or future use.
  454. </documentation>
  455. </annotation>
  456. </enumeration>
  457. </restriction>
  458. </simpleType>
  459. <simpleType name="CountryCodeType">
  460. <annotation>
  461. <documentation>
  462. CountryCodeType
  463. This code list module defines the enumerated types
  464. of standard 2-letter ISO 3166 country codes. This codelist
  465. contains some additional country code not defined in
  466. the ISO 3166 country code set.
  467. </documentation>
  468. </annotation>
  469. <restriction base="xs:token">
  470. <enumeration value="AF"/>
  471. <enumeration value="AL"/>
  472. <enumeration value="DZ"/>
  473. <enumeration value="AS"/>
  474. <enumeration value="AD"/>
  475. <enumeration value="AO"/>
  476. <enumeration value="AI"/>
  477. <enumeration value="AQ"/>
  478. <enumeration value="AG"/>
  479. <enumeration value="AR"/>
  480. <enumeration value="AM"/>
  481. <enumeration value="AW"/>
  482. <enumeration value="AU"/>
  483. <enumeration value="AT"/>
  484. <enumeration value="AZ"/>
  485. <enumeration value="BS"/>
  486. <enumeration value="BH"/>
  487. <enumeration value="BD"/>
  488. <enumeration value="BB"/>
  489. <enumeration value="BY"/>
  490. <enumeration value="BE"/>
  491. <enumeration value="BZ"/>
  492. <enumeration value="BJ"/>
  493. <enumeration value="BM"/>
  494. <enumeration value="BT"/>
  495. <enumeration value="BO"/>
  496. <enumeration value="BA"/>
  497. <enumeration value="BW"/>
  498. <enumeration value="BV"/>
  499. <enumeration value="BR"/>
  500. <enumeration value="IO"/>
  501. <enumeration value="BN"/>
  502. <enumeration value="BG"/>
  503. <enumeration value="BF"/>
  504. <enumeration value="BI"/>
  505. <enumeration value="KH"/>
  506. <enumeration value="CM"/>
  507. <enumeration value="CA"/>
  508. <enumeration value="CV"/>
  509. <enumeration value="KY"/>
  510. <enumeration value="CF"/>
  511. <enumeration value="TD"/>
  512. <enumeration value="CL"/>
  513. <enumeration value="C2"/>
  514. <enumeration value="CN"/>
  515. <enumeration value="CX"/>
  516. <enumeration value="CC"/>
  517. <enumeration value="CO"/>
  518. <enumeration value="KM"/>
  519. <enumeration value="CG"/>
  520. <enumeration value="CD"/>
  521. <enumeration value="CK"/>
  522. <enumeration value="CR"/>
  523. <enumeration value="CI"/>
  524. <enumeration value="HR"/>
  525. <enumeration value="CU"/>
  526. <enumeration value="CY"/>
  527. <enumeration value="CZ"/>
  528. <enumeration value="DK"/>
  529. <enumeration value="DJ"/>
  530. <enumeration value="DM"/>
  531. <enumeration value="DO"/>
  532. <enumeration value="TP"/>
  533. <enumeration value="EC"/>
  534. <enumeration value="EG"/>
  535. <enumeration value="SV"/>
  536. <enumeration value="GQ"/>
  537. <enumeration value="ER"/>
  538. <enumeration value="EE"/>
  539. <enumeration value="ET"/>
  540. <enumeration value="FK"/>
  541. <enumeration value="FO"/>
  542. <enumeration value="FJ"/>
  543. <enumeration value="FI"/>
  544. <enumeration value="FR"/>
  545. <enumeration value="GF"/>
  546. <enumeration value="PF"/>
  547. <enumeration value="TF"/>
  548. <enumeration value="GA"/>
  549. <enumeration value="GM"/>
  550. <enumeration value="GE"/>
  551. <enumeration value="DE"/>
  552. <enumeration value="GH"/>
  553. <enumeration value="GI"/>
  554. <enumeration value="GR"/>
  555. <enumeration value="GL"/>
  556. <enumeration value="GD"/>
  557. <enumeration value="GP"/>
  558. <enumeration value="GU"/>
  559. <enumeration value="GT"/>
  560. <enumeration value="GN"/>
  561. <enumeration value="GW"/>
  562. <enumeration value="GY"/>
  563. <enumeration value="HT"/>
  564. <enumeration value="HM"/>
  565. <enumeration value="VA"/>
  566. <enumeration value="HN"/>
  567. <enumeration value="HK"/>
  568. <enumeration value="HU"/>
  569. <enumeration value="IS"/>
  570. <enumeration value="IN"/>
  571. <enumeration value="ID"/>
  572. <enumeration value="IR"/>
  573. <enumeration value="IQ"/>
  574. <enumeration value="IE"/>
  575. <enumeration value="IL"/>
  576. <enumeration value="IT"/>
  577. <enumeration value="JM"/>
  578. <enumeration value="JP"/>
  579. <enumeration value="JO"/>
  580. <enumeration value="KZ"/>
  581. <enumeration value="KE"/>
  582. <enumeration value="KI"/>
  583. <enumeration value="KP"/>
  584. <enumeration value="KR"/>
  585. <enumeration value="KW"/>
  586. <enumeration value="KG"/>
  587. <enumeration value="LA"/>
  588. <enumeration value="LV"/>
  589. <enumeration value="LB"/>
  590. <enumeration value="LS"/>
  591. <enumeration value="LR"/>
  592. <enumeration value="LY"/>
  593. <enumeration value="LI"/>
  594. <enumeration value="LT"/>
  595. <enumeration value="LU"/>
  596. <enumeration value="MO"/>
  597. <enumeration value="MK"/>
  598. <enumeration value="MG"/>
  599. <enumeration value="MW"/>
  600. <enumeration value="MY"/>
  601. <enumeration value="MV"/>
  602. <enumeration value="ML"/>
  603. <enumeration value="MT"/>
  604. <enumeration value="MH"/>
  605. <enumeration value="MQ"/>
  606. <enumeration value="MR"/>
  607. <enumeration value="MU"/>
  608. <enumeration value="YT"/>
  609. <enumeration value="MX"/>
  610. <enumeration value="FM"/>
  611. <enumeration value="MD"/>
  612. <enumeration value="MC"/>
  613. <enumeration value="MN"/>
  614. <enumeration value="MS"/>
  615. <enumeration value="MA"/>
  616. <enumeration value="MZ"/>
  617. <enumeration value="MM"/>
  618. <enumeration value="NA"/>
  619. <enumeration value="NR"/>
  620. <enumeration value="NP"/>
  621. <enumeration value="NL"/>
  622. <enumeration value="AN"/>
  623. <enumeration value="NC"/>
  624. <enumeration value="NZ"/>
  625. <enumeration value="NI"/>
  626. <enumeration value="NE"/>
  627. <enumeration value="NG"/>
  628. <enumeration value="NU"/>
  629. <enumeration value="NF"/>
  630. <enumeration value="MP"/>
  631. <enumeration value="NO"/>
  632. <enumeration value="OM"/>
  633. <enumeration value="PK"/>
  634. <enumeration value="PW"/>
  635. <enumeration value="PS"/>
  636. <enumeration value="PA"/>
  637. <enumeration value="PG"/>
  638. <enumeration value="PY"/>
  639. <enumeration value="PE"/>
  640. <enumeration value="PH"/>
  641. <enumeration value="PN"/>
  642. <enumeration value="PL"/>
  643. <enumeration value="PT"/>
  644. <enumeration value="PR"/>
  645. <enumeration value="QA"/>
  646. <enumeration value="RE"/>
  647. <enumeration value="RO"/>
  648. <enumeration value="RU"/>
  649. <enumeration value="RW"/>
  650. <enumeration value="SH"/>
  651. <enumeration value="KN"/>
  652. <enumeration value="LC"/>
  653. <enumeration value="PM"/>
  654. <enumeration value="VC"/>
  655. <enumeration value="WS"/>
  656. <enumeration value="SM"/>
  657. <enumeration value="ST"/>
  658. <enumeration value="SA"/>
  659. <enumeration value="SN"/>
  660. <enumeration value="SC"/>
  661. <enumeration value="SL"/>
  662. <enumeration value="SG"/>
  663. <enumeration value="SK"/>
  664. <enumeration value="SI"/>
  665. <enumeration value="SB"/>
  666. <enumeration value="SO"/>
  667. <enumeration value="ZA"/>
  668. <enumeration value="GS"/>
  669. <enumeration value="ES"/>
  670. <enumeration value="LK"/>
  671. <enumeration value="SD"/>
  672. <enumeration value="SR"/>
  673. <enumeration value="SJ"/>
  674. <enumeration value="SZ"/>
  675. <enumeration value="SE"/>
  676. <enumeration value="CH"/>
  677. <enumeration value="SY"/>
  678. <enumeration value="TW"/>
  679. <enumeration value="TJ"/>
  680. <enumeration value="TZ"/>
  681. <enumeration value="TH"/>
  682. <enumeration value="TG"/>
  683. <enumeration value="TK"/>
  684. <enumeration value="TO"/>
  685. <enumeration value="TT"/>
  686. <enumeration value="TN"/>
  687. <enumeration value="TR"/>
  688. <enumeration value="TM"/>
  689. <enumeration value="TC"/>
  690. <enumeration value="TV"/>
  691. <enumeration value="UG"/>
  692. <enumeration value="UA"/>
  693. <enumeration value="AE"/>
  694. <enumeration value="GB"/>
  695. <enumeration value="US"/>
  696. <enumeration value="UM"/>
  697. <enumeration value="UY"/>
  698. <enumeration value="UZ"/>
  699. <enumeration value="VU"/>
  700. <enumeration value="VE"/>
  701. <enumeration value="VN"/>
  702. <enumeration value="VG"/>
  703. <enumeration value="VI"/>
  704. <enumeration value="WF"/>
  705. <enumeration value="EH"/>
  706. <enumeration value="YE"/>
  707. <enumeration value="YU"/>
  708. <enumeration value="ZM"/>
  709. <enumeration value="ZW"/>
  710. <enumeration value="AA">
  711. <annotation>
  712. <documentation>
  713. NOTE: APO/FPO was defined in eBay list previously
  714. but they are not defined in ISO 3166. This country
  715. will remain on eBay country code list for backward
  716. compatibility.
  717. </documentation>
  718. </annotation>
  719. </enumeration>
  720. <enumeration value="QM">
  721. <annotation>
  722. <documentation>
  723. NOTE: Guernsey was defined in eBay list previously
  724. but they are not defined in ISO 3166. This country
  725. will remain on eBay country list for backward
  726. compatibility.
  727. </documentation>
  728. </annotation>
  729. </enumeration>
  730. <enumeration value="QN">
  731. <annotation>
  732. <documentation>
  733. NOTE: Jan Mayen was defined in eBay list previously
  734. but they are not defined in ISO 3166. This country
  735. will remain on eBay country list for backward
  736. compatibility.
  737. </documentation>
  738. </annotation>
  739. </enumeration>
  740. <enumeration value="QO">
  741. <annotation>
  742. <documentation>
  743. NOTE: Jersey was defined in eBay list previously
  744. but they are not defined in ISO 3166. This country
  745. will remain on eBay country list for backward
  746. compatibility.
  747. </documentation>
  748. </annotation>
  749. </enumeration>
  750. <enumeration value="QP">
  751. <annotation>
  752. <documentation>
  753. NOTE: Tahiti was defined in eBay list previously
  754. but they are not defined in ISO 3166. This country
  755. will remain on eBay country list for backward
  756. compatibility.
  757. </documentation>
  758. </annotation>
  759. </enumeration>
  760. <enumeration value="CS">
  761. <annotation>
  762. <documentation>
  763. NOTE: Serbia and Montenegro was not defined in the list previously
  764. but now an ISO 3166 code has been defined. As of 41.0 this
  765. country is supported in PayPal PRO.
  766. </documentation>
  767. </annotation>
  768. </enumeration>
  769. <enumeration value="CustomCode">
  770. <annotation>
  771. <documentation>
  772. Reserved for internal or future use.
  773. </documentation>
  774. </annotation>
  775. </enumeration>
  776. <enumeration value="GG"/>
  777. <enumeration value="IM"/>
  778. <enumeration value="JE"/>
  779. <enumeration value="TL"/>
  780. </restriction>
  781. </simpleType>
  782. <simpleType name="CurrencyCodeType">
  783. <annotation>
  784. <documentation>
  785. ISO 4217 standard 3-letter currency code.
  786. <br/>
  787. <br/>
  788. The following currencies are supported by PayPal.
  789. <table>
  790. <th>Code</th>
  791. <th>Currency<th/>Maximum Transaction Amount</th>
  792. <tr>
  793. <td>AUD</td>
  794. <td>Australian Dollar </td>
  795. <td>12,500 AUD</td>
  796. </tr>
  797. <tr>
  798. <td>CAD</td>
  799. <td>Canadian Dollar<td/>12,500 CAD</td>
  800. </tr>
  801. <tr>
  802. <td>EUR</td>
  803. <td>Euro</td>
  804. <td> 8,000 EUR</td>
  805. </tr>
  806. <tr>
  807. <td>GBP</td>
  808. <td>Pound Sterling</td>
  809. <td> 5,500 GBP</td>
  810. </tr>
  811. <tr>
  812. <td>JPY</td>
  813. <td>Japanese Yen</td>
  814. <td>1,000,000 JPY</td>
  815. </tr>
  816. <tr>
  817. <td>USD</td>
  818. <td> U.S. Dollar</td>
  819. <td>10,000 USD</td>
  820. </tr>
  821. <tr>
  822. <td>CHF</td>
  823. <td> Czech Koruna</td>
  824. <td>70,000 CHF</td>
  825. </tr>
  826. <tr>
  827. <td>SEK</td>
  828. <td> Swedish Krona</td>
  829. <td>3,50,000 SEK</td>
  830. </tr>
  831. <tr>
  832. <td>NOK</td>
  833. <td> Norwegian Krone</td>
  834. <td>4,00,000 NOK</td>
  835. </tr>
  836. <tr>
  837. <td>DKK</td>
  838. <td> Danish Krone</td>
  839. <td>3,00,000 DKK</td>
  840. </tr>
  841. <tr>
  842. <td>PLN</td>
  843. <td> Poland Zloty</td>
  844. <td>1,60,000 PLN</td>
  845. </tr>
  846. <tr>
  847. <td>HUF</td>
  848. <td> Hungary Forint</td>
  849. <td>110,00,000 HUF</td>
  850. </tr>
  851. <tr>
  852. <td>SGD</td>
  853. <td> Singapore Dollar</td>
  854. <td>80,000 SGD</td>
  855. </tr>
  856. <tr>
  857. <td>HKD</td>
  858. <td> HongKong Dollar</td>
  859. <td>3,80,000 HKD</td>
  860. </tr>
  861. <tr>
  862. <td>NZD</td>
  863. <td> New Zealand Dollar</td>
  864. <td>77,000 NZD</td>
  865. </tr>
  866. <tr>
  867. <td>CZK</td>
  868. <td> Czech Koruna</td>
  869. <td>1,20,000 CZK</td>
  870. </tr>
  871. </table>
  872. </documentation>
  873. </annotation>
  874. <restriction base="xs:token">
  875. <enumeration value="AFA"/>
  876. <enumeration value="ALL"/>
  877. <enumeration value="DZD"/>
  878. <enumeration value="ADP"/>
  879. <enumeration value="AOA"/>
  880. <enumeration value="ARS"/>
  881. <enumeration value="AMD"/>
  882. <enumeration value="AWG"/>
  883. <enumeration value="AZM"/>
  884. <enumeration value="BSD"/>
  885. <enumeration value="BHD"/>
  886. <enumeration value="BDT"/>
  887. <enumeration value="BBD"/>
  888. <enumeration value="BYR"/>
  889. <enumeration value="BZD"/>
  890. <enumeration value="BMD"/>
  891. <enumeration value="BTN"/>
  892. <enumeration value="INR"/>
  893. <enumeration value="BOV"/>
  894. <enumeration value="BOB"/>
  895. <enumeration value="BAM"/>
  896. <enumeration value="BWP"/>
  897. <enumeration value="BRL"/>
  898. <enumeration value="BND"/>
  899. <enumeration value="BGL"/>
  900. <enumeration value="BGN"/>
  901. <enumeration value="BIF"/>
  902. <enumeration value="KHR"/>
  903. <enumeration value="CAD"/>
  904. <enumeration value="CVE"/>
  905. <enumeration value="KYD"/>
  906. <enumeration value="XAF"/>
  907. <enumeration value="CLF"/>
  908. <enumeration value="CLP"/>
  909. <enumeration value="CNY"/>
  910. <enumeration value="COP"/>
  911. <enumeration value="KMF"/>
  912. <enumeration value="CDF"/>
  913. <enumeration value="CRC"/>
  914. <enumeration value="HRK"/>
  915. <enumeration value="CUP"/>
  916. <enumeration value="CYP"/>
  917. <enumeration value="CZK"/>
  918. <enumeration value="DKK"/>
  919. <enumeration value="DJF"/>
  920. <enumeration value="DOP"/>
  921. <enumeration value="TPE"/>
  922. <enumeration value="ECV"/>
  923. <enumeration value="ECS"/>
  924. <enumeration value="EGP"/>
  925. <enumeration value="SVC"/>
  926. <enumeration value="ERN"/>
  927. <enumeration value="EEK"/>
  928. <enumeration value="ETB"/>
  929. <enumeration value="FKP"/>
  930. <enumeration value="FJD"/>
  931. <enumeration value="GMD"/>
  932. <enumeration value="GEL"/>
  933. <enumeration value="GHC"/>
  934. <enumeration value="GIP"/>
  935. <enumeration value="GTQ"/>
  936. <enumeration value="GNF"/>
  937. <enumeration value="GWP"/>
  938. <enumeration value="GYD"/>
  939. <enumeration value="HTG"/>
  940. <enumeration value="HNL"/>
  941. <enumeration value="HKD"/>
  942. <enumeration value="HUF"/>
  943. <enumeration value="ISK"/>
  944. <enumeration value="IDR"/>
  945. <enumeration value="IRR"/>
  946. <enumeration value="IQD"/>
  947. <enumeration value="ILS"/>
  948. <enumeration value="JMD"/>
  949. <enumeration value="JPY"/>
  950. <enumeration value="JOD"/>
  951. <enumeration value="KZT"/>
  952. <enumeration value="KES"/>
  953. <enumeration value="AUD"/>
  954. <enumeration value="KPW"/>
  955. <enumeration value="KRW"/>
  956. <enumeration value="KWD"/>
  957. <enumeration value="KGS"/>
  958. <enumeration value="LAK"/>
  959. <enumeration value="LVL"/>
  960. <enumeration value="LBP"/>
  961. <enumeration value="LSL"/>
  962. <enumeration value="LRD"/>
  963. <enumeration value="LYD"/>
  964. <enumeration value="CHF"/>
  965. <enumeration value="LTL"/>
  966. <enumeration value="MOP"/>
  967. <enumeration value="MKD"/>
  968. <enumeration value="MGF"/>
  969. <enumeration value="MWK"/>
  970. <enumeration value="MYR"/>
  971. <enumeration value="MVR"/>
  972. <enumeration value="MTL"/>
  973. <enumeration value="EUR"/>
  974. <enumeration value="MRO"/>
  975. <enumeration value="MUR"/>
  976. <enumeration value="MXN"/>
  977. <enumeration value="MXV"/>
  978. <enumeration value="MDL"/>
  979. <enumeration value="MNT"/>
  980. <enumeration value="XCD"/>
  981. <enumeration value="MZM"/>
  982. <enumeration value="MMK"/>
  983. <enumeration value="ZAR"/>
  984. <enumeration value="NAD"/>
  985. <enumeration value="NPR"/>
  986. <enumeration value="ANG"/>
  987. <enumeration value="XPF"/>
  988. <enumeration value="NZD"/>
  989. <enumeration value="NIO"/>
  990. <enumeration value="NGN"/>
  991. <enumeration value="NOK"/>
  992. <enumeration value="OMR"/>
  993. <enumeration value="PKR"/>
  994. <enumeration value="PAB"/>
  995. <enumeration value="PGK"/>
  996. <enumeration value="PYG"/>
  997. <enumeration value="PEN"/>
  998. <enumeration value="PHP"/>
  999. <enumeration value="PLN"/>
  1000. <enumeration value="USD"/>
  1001. <enumeration value="QAR"/>
  1002. <enumeration value="ROL"/>
  1003. <enumeration value="RUB"/>
  1004. <enumeration value="RUR"/>
  1005. <enumeration value="RWF"/>
  1006. <enumeration value="SHP"/>
  1007. <enumeration value="WST"/>
  1008. <enumeration value="STD"/>
  1009. <enumeration value="SAR"/>
  1010. <enumeration value="SCR"/>
  1011. <enumeration value="SLL"/>
  1012. <enumeration value="SGD"/>
  1013. <enumeration value="SKK"/>
  1014. <enumeration value="SIT"/>
  1015. <enumeration value="SBD"/>
  1016. <enumeration value="SOS"/>
  1017. <enumeration value="LKR"/>
  1018. <enumeration value="SDD"/>
  1019. <enumeration value="SRG"/>
  1020. <enumeration value="SZL"/>
  1021. <enumeration value="SEK"/>
  1022. <enumeration value="SYP"/>
  1023. <enumeration value="TWD"/>
  1024. <enumeration value="TJS"/>
  1025. <enumeration value="TZS"/>
  1026. <enumeration value="THB"/>
  1027. <enumeration value="XOF"/>
  1028. <enumeration value="TOP"/>
  1029. <enumeration value="TTD"/>
  1030. <enumeration value="TND"/>
  1031. <enumeration value="TRL"/>
  1032. <enumeration value="TMM"/>
  1033. <enumeration value="UGX"/>
  1034. <enumeration value="UAH"/>
  1035. <enumeration value="AED"/>
  1036. <enumeration value="GBP"/>
  1037. <enumeration value="USS"/>
  1038. <enumeration value="USN"/>
  1039. <enumeration value="UYU"/>
  1040. <enumeration value="UZS"/>
  1041. <enumeration value="VUV"/>
  1042. <enumeration value="VEB"/>
  1043. <enumeration value="VND"/>
  1044. <enumeration value="MAD"/>
  1045. <enumeration value="YER"/>
  1046. <enumeration value="YUM"/>
  1047. <enumeration value="ZMK"/>
  1048. <enumeration value="ZWD"/>
  1049. <enumeration value="CustomCode">
  1050. <annotation>
  1051. <documentation>
  1052. Reserved for internal or future use.
  1053. </documentation>
  1054. </annotation>
  1055. </enumeration>
  1056. </restriction>
  1057. </simpleType>
  1058. <simpleType name="DepositTypeCodeType">
  1059. <annotation>
  1060. <documentation>
  1061. DepositTypeCodeType - Type declaration to be used by other schema's.
  1062. This code identifies the DepositType codes used to specify deposit
  1063. types for Motors items. If the ietm listed is not a Motors item, then always
  1064. return DepositType value to be "None".
  1065. </documentation>
  1066. </annotation>
  1067. <restriction base="xs:token">
  1068. <enumeration value="None">
  1069. <annotation>
  1070. <documentation>None</documentation>
  1071. </annotation>
  1072. </enumeration>
  1073. <enumeration value="OtherMethod">
  1074. <annotation>
  1075. <documentation>
  1076. Other Method
  1077. </documentation>
  1078. </annotation>
  1079. </enumeration>
  1080. <enumeration value="FastDeposit">
  1081. <annotation>
  1082. <documentation>
  1083. Fast Deposit. </documentation>
  1084. </annotation>
  1085. </enumeration>
  1086. <enumeration value="CustomCode">
  1087. <annotation>
  1088. <documentation>
  1089. Reserved for internal or future use.
  1090. </documentation>
  1091. </annotation>
  1092. </enumeration>
  1093. </restriction>
  1094. </simpleType>
  1095. <simpleType name="DetailLevelCodeType">
  1096. <annotation>
  1097. <documentation>
  1098. DetailLevelCodeType
  1099. </documentation>
  1100. </annotation>
  1101. <restriction base="xs:token">
  1102. <enumeration value="ReturnAll">
  1103. <annotation>
  1104. <documentation>
  1105. Return in response message all detail levels.
  1106. </documentation>
  1107. </annotation>
  1108. </enumeration>
  1109. <enumeration value="ItemReturnDescription">
  1110. <annotation>
  1111. <documentation>
  1112. Return item description.
  1113. </documentation>
  1114. </annotation>
  1115. </enumeration>
  1116. <enumeration value="ItemReturnAttributes">
  1117. <annotation>
  1118. <documentation>
  1119. Return attributes as part of the item.
  1120. </documentation>
  1121. </annotation>
  1122. </enumeration>
  1123. </restriction>
  1124. </simpleType>
  1125. <annotation>
  1126. <documentation>
  1127. This file defines re-useable base and aggregate components of the
  1128. eBay Business Lanaguage (eBL) that would be used to compose
  1129. message payloads for eBay APIs.
  1130. </documentation>
  1131. </annotation>
  1132. <simpleType name="IncentiveSiteAppliedOnType">
  1133. <annotation>
  1134. <documentation>
  1135. This defines if the incentive is applied on Ebay or PayPal.
  1136. </documentation>
  1137. </annotation>
  1138. <restriction base="xs:token">
  1139. <enumeration value="INCENTIVE-SITE-APPLIED-ON-UNKNOWN"/>
  1140. <enumeration value="INCENTIVE-SITE-APPLIED-ON-MERCHANT"/>
  1141. <enumeration value="INCENTIVE-SITE-APPLIED-ON-PAYPAL"/>
  1142. </restriction>
  1143. </simpleType>
  1144. <simpleType name="IncentiveAppliedStatusType">
  1145. <annotation>
  1146. <documentation>
  1147. This defines if the incentive is applied successfully or not.
  1148. </documentation>
  1149. </annotation>
  1150. <restriction base="xs:token">
  1151. <enumeration value="INCENTIVE-APPLIED-STATUS-SUCCESS"/>
  1152. <enumeration value="INCENTIVE-APPLIED-STATUS-ERROR"/>
  1153. </restriction>
  1154. </simpleType>
  1155. <simpleType name="ItemIDType">
  1156. <annotation>
  1157. <documentation>
  1158. Represents the unique identifier for an item. To be used to specify the
  1159. elements that represents an ItemID.
  1160. </documentation>
  1161. </annotation>
  1162. <restriction base="xs:string"/>
  1163. </simpleType>
  1164. <complexType name="AccountEntryType">
  1165. <sequence>
  1166. <element ref="ns:Balance">
  1167. <annotation>
  1168. <documentation>
  1169. Balance as of a given entry, can be 0.00.
  1170. </documentation>
  1171. </annotation>
  1172. </element>
  1173. <element name="Credit" type="cc:AmountType">
  1174. <annotation>
  1175. <documentation>
  1176. Credit Amount for a detail entry, can be 0.00.
  1177. </documentation>
  1178. </annotation>
  1179. </element>
  1180. <element name="Date" type="xs:dateTime">
  1181. <annotation>
  1182. <documentation>
  1183. Date entry was posted, in GMT.
  1184. </documentation>
  1185. </annotation>
  1186. </element>
  1187. <element name="Debit" type="cc:AmountType">
  1188. <annotation>
  1189. <documentation>
  1190. Debit Amount for this detail entry, can be 0.00.
  1191. </documentation>
  1192. </annotation>
  1193. </element>
  1194. <element ref="ns:ItemID">
  1195. <annotation>
  1196. <documentation>
  1197. Item number if transaction is associated with an auction or 0
  1198. if no item is associated with an account entry.
  1199. </documentation>
  1200. </annotation>
  1201. </element>
  1202. <element name="Memo" type="xs:string">
  1203. <annotation>
  1204. <documentation>
  1205. Memo line for an account entry, can be empty string.
  1206. </documentation>
  1207. </annotation>
  1208. </element>
  1209. <element name="RefNumber" type="xs:int">
  1210. <annotation>
  1211. <documentation>
  1212. eBay reference number for an account entry.
  1213. </documentation>
  1214. </annotation>
  1215. </element>
  1216. <element name="AccountEntryDetailsType" type="xs:int">
  1217. <annotation>
  1218. <documentation>
  1219. Integer code for account details entry type. This element
  1220. element specifies an index to a table of explanations for
  1221. accounting charges.
  1222. </documentation>
  1223. </annotation>
  1224. </element>
  1225. </sequence>
  1226. </complexType>
  1227. <complexType name="AdditionalAccountType">
  1228. <annotation>
  1229. <documentation>
  1230. The AdditionalAccount component represents historical data related to
  1231. accounts that the user held with a country of residency other than
  1232. the current one. eBay users can have one active account at a time.
  1233. For users who change their country of residency and modify their
  1234. eBay registration to reflect this change, the new country of residence
  1235. becomes the currently active account. Any account associated with
  1236. a previous country is treated as an additional account. Because the
  1237. currency for these additional accounts are different than the active
  1238. account, each additional account includes an indicator of the currency
  1239. for that account. Users who never change their country of residence
  1240. will not have any additional accounts.
  1241. </documentation>
  1242. </annotation>
  1243. <sequence>
  1244. <element ref="ns:Balance"/>
  1245. <element ref="ns:Currency"/>
  1246. <element ref="ns:AccountCode"/>
  1247. </sequence>
  1248. </complexType>
  1249. <complexType name="PromotedItemType">
  1250. <annotation>
  1251. <documentation>
  1252. Merchandizing info for an Item. This contains a list of crosssell
  1253. or upsell items.
  1254. </documentation>
  1255. </annotation>
  1256. <sequence>
  1257. <element name="ItemID" type="ns:ItemIDType">
  1258. <annotation>
  1259. <documentation>
  1260. Item ID for the base item. Based on this item other items are
  1261. promoted. it is teh only tag that would show up in all calls that use promoted item type.
  1262. some are not in soap yet, such as get and ser promotion rules
  1263. </documentation>
  1264. </annotation>
  1265. </element>
  1266. <element name="PictureURL" type="xs:string" minOccurs="0">
  1267. <annotation>
  1268. <documentation>
  1269. URL for the picture of the promoted item.
  1270. </documentation>
  1271. </annotation>
  1272. </element>
  1273. <element name="position" type="xs:int" minOccurs="0">
  1274. <annotation>
  1275. <documentation>
  1276. Where to display in the list of items.currentl y even forget and set does not have to be minoccur =0
  1277. but if we ever were to do revise promotion tems, it can be omitted
  1278. </documentation>
  1279. </annotation>
  1280. </element>
  1281. <element name="PromotionPrice" type="cc:AmountType" minOccurs="0">
  1282. <annotation>
  1283. <documentation>
  1284. Promotion Price. Price at which the buyer can buy the item now.
  1285. </documentation>
  1286. </annotation>
  1287. </element>
  1288. <element name="PromotionPriceType" type="ns:PromotionItemPriceTypeCodeType" minOccurs="0"/>
  1289. <element name="SelectionType" type="ns:PromotionItemSelectionCodeType" minOccurs="0"/>
  1290. <element name="Title" type="xs:string" minOccurs="0">
  1291. <annotation>
  1292. <documentation>
  1293. Item Title for the promoted item.
  1294. </documentation>
  1295. </annotation>
  1296. </element>
  1297. <element name="ListingType" type="ns:ListingTypeCodeType" minOccurs="0"/>
  1298. </sequence>
  1299. </complexType>
  1300. <complexType name="CrossPromotionsType">
  1301. <annotation>
  1302. <documentation>
  1303. Merchandizing info for an Item. This contains a list of crosssell
  1304. or upsell items.
  1305. PrimaryScheme, PromotionMethod,SellerId,ItemId, ShippingDiscount
  1306. do not have be min occur 0
  1307. </documentation>
  1308. </annotation>
  1309. <sequence>
  1310. <element name="ItemID" type="ns:ItemIDType">
  1311. <annotation>
  1312. <documentation>
  1313. Item ID for the base item. Based on this item other items are
  1314. promoted.
  1315. </documentation>
  1316. </annotation>
  1317. </element>
  1318. <element name="PrimaryScheme" type="ns:PromotionSchemeCodeType"/>
  1319. <element name="PromotionMethod" type="ns:PromotionMethodCodeType"/>
  1320. <element name="SellerID" type="xs:string">
  1321. <annotation>
  1322. <documentation>
  1323. Id of the Seller who is promoting this item.
  1324. </documentation>
  1325. </annotation>
  1326. </element>
  1327. <element name="ShippingDiscount" type="xs:boolean">
  1328. <annotation>
  1329. <documentation>
  1330. Shipping Discount offered or not by the seller.
  1331. </documentation>
  1332. </annotation>
  1333. </element>
  1334. <element name="SellerKey" type="xs:string" minOccurs="0">
  1335. <annotation>
  1336. <documentation>
  1337. Key of the Seller who is promoting this item.
  1338. </documentation>
  1339. </annotation>
  1340. </element>
  1341. <element name="StoreName" type="xs:string" minOccurs="0">
  1342. <annotation>
  1343. <documentation>
  1344. Store Name for the seller.
  1345. </documentation>
  1346. </annotation>
  1347. </element>
  1348. <element name="PromotedItem" type="ns:PromotedItemType" maxOccurs="unbounded"/>
  1349. </sequence>
  1350. </complexType>
  1351. <complexType name="AccountSummaryType" mixed="true">
  1352. <annotation>
  1353. <documentation>
  1354. Includes account summary for the user.
  1355. </documentation>
  1356. </annotation>
  1357. <choice minOccurs="0" maxOccurs="unbounded">
  1358. <element name="AccountState" type="ns:AccountStateCodeType" minOccurs="0"/>
  1359. <element name="AdditionalAccount" type="ns:AdditionalAccountType" minOccurs="0" maxOccurs="unbounded"/>
  1360. <element name="AdditionalAccountsCount" type="xs:int">
  1361. <annotation>
  1362. <documentation>
  1363. Number of additional accounts.
  1364. </documentation>
  1365. </annotation>
  1366. </element>
  1367. <element ref="ns:AmountPastDue" minOccurs="0">
  1368. <annotation>
  1369. <documentation>
  1370. Amount past due, 0.00 if not past due.
  1371. </documentation>
  1372. </annotation>
  1373. </element>
  1374. <element name="BankAccountInfo" type="xs:string">
  1375. <annotation>
  1376. <documentation>
  1377. First four digits (with remainder Xed-out). This may be an empty
  1378. string depending upon the value of the payment type for the
  1379. user account (e.g, if no debit-card specified).
  1380. </documentation>
  1381. </annotation>
  1382. </element>
  1383. <element name="BankModifyDate" type="xs:dateTime">
  1384. <annotation>
  1385. <documentation>
  1386. Last time/day BankAccountInfo and/or BankRoutingInfo was
  1387. modified, in GMT. This may be an empty string depending
  1388. upon the value of the payment type for the user account
  1389. (e.g, if no debit-card specified).
  1390. </documentation>
  1391. </annotation>
  1392. </element>
  1393. <element name="BillingCycleDate" type="xs:dateTime">
  1394. <annotation>
  1395. <documentation>
  1396. Indicates the billing cycle in which eBay sends a billing
  1397. invoice to the specified user. Possible values:
  1398. 0 = On the last day of the month.
  1399. 15 = On the 15th day of the month.
  1400. </documentation>
  1401. </annotation>
  1402. </element>
  1403. <element name="CCExp" type="xs:dateTime">
  1404. <annotation>
  1405. <documentation>
  1406. Expiration date for the credit card selected as payment method,
  1407. in GMT. Empty string if no credit card is on file or if account is
  1408. inactive -- even if there is a credit card on file.
  1409. </documentation>
  1410. </annotation>
  1411. </element>
  1412. <element name="CCInfo" type="xs:string">
  1413. <annotation>
  1414. <documentation>
  1415. Last four digits of user's credit card selected as payment
  1416. type. Empty string if no credit is on file. This may be an empty
  1417. string depending upon the value of the payment type for the
  1418. user account (e.g, if no debit-card specified).
  1419. </documentation>
  1420. </annotation>
  1421. </element>
  1422. <element name="CCModifyDate" type="xs:dateTime">
  1423. <annotation>
  1424. <documentation>
  1425. Last date credit card or credit card expiration date was
  1426. modified, in GMT. This may be an empty string depending
  1427. upon the value of the payment type for the user account
  1428. (e.g, Empty string if no credit card is on file.
  1429. </documentation>
  1430. </annotation>
  1431. </element>
  1432. <element ref="ns:CurrentBalance">
  1433. <annotation>
  1434. <documentation>
  1435. User's current balance. Can be 0.00, positive, or negative.
  1436. </documentation>
  1437. </annotation>
  1438. </element>
  1439. <element name="LastAmountPaid" type="cc:AmountType">
  1440. <annotation>
  1441. <documentation>
  1442. Amount of last payment posted, 0.00 if no payments posted.
  1443. </documentation>
  1444. </annotation>
  1445. </element>
  1446. <element name="LastInvoiceAmount" type="cc:AmountType">
  1447. <annotation>
  1448. <documentation>
  1449. Amount of last invoice. 0.00 if account not yet invoiced.
  1450. </documentation>
  1451. </annotation>
  1452. </element>
  1453. <element name="LastInvoiceDate" type="xs:dateTime">
  1454. <annotation>
  1455. <documentation>
  1456. Date of last invoice sent by eBay to the user, in GMT.
  1457. Empty string if this account has not been invoiced yet.
  1458. </documentation>
  1459. </annotation>
  1460. </element>
  1461. <element name="LastPaymentDate" type="xs:dateTime">
  1462. <annotation>
  1463. <documentation>
  1464. Date of last payment by specified user to eBay, in GMT.
  1465. Empty string if no payments posted.
  1466. </documentation>
  1467. </annotation>
  1468. </element>
  1469. <element name="PastDue" type="xs:boolean">
  1470. <annotation>
  1471. <documentation>
  1472. Indicates whether the account has past due amounts
  1473. outstanding. Possible values:
  1474. true = Account is past due.
  1475. false = Account is current.
  1476. </documentation>
  1477. </annotation>
  1478. </element>
  1479. <element name="PaymentMethod" type="ns:SellerPaymentMethodCodeType">
  1480. <annotation>
  1481. <documentation>
  1482. Indicates the method the specified user selected for paying
  1483. eBay. The values for PaymentType vary for each SiteID.
  1484. </documentation>
  1485. </annotation>
  1486. </element>
  1487. </choice>
  1488. </complexType>
  1489. <complexType name="BuyerType">
  1490. <annotation>
  1491. <documentation>
  1492. Information about user used by buying applications
  1493. </documentation>
  1494. </annotation>
  1495. <sequence>
  1496. <element ref="ns:ShippingAddress" minOccurs="0"/>
  1497. </sequence>
  1498. </complexType>
  1499. <complexType name="SellerType">
  1500. <annotation>
  1501. <documentation>
  1502. Information about user used by selling applications
  1503. there are number of required elements - they will always show up for seller node
  1504. there is not such a call to do revise seller info. only added minoccur=0 to elements that will not show up in every
  1505. type of request/responce
  1506. </documentation>
  1507. </annotation>
  1508. <sequence>
  1509. <element name="AllowPaymentEdit" type="xs:boolean"/>
  1510. <element name="BillingCurrency" type="ns:CurrencyCodeType" minOccurs="0"/>
  1511. <element ref="ns:CheckoutEnabled"/>
  1512. <element name="CIPBankAccountStored" type="xs:boolean"/>
  1513. <element name="GoodStanding" type="xs:boolean"/>
  1514. <element name="LiveAuctionAuthorized" type="xs:boolean"/>
  1515. <element name="MerchandizingPref" type="ns:MerchandizingPrefCodeType">
  1516. <annotation>
  1517. <documentation>
  1518. Indicates whether the user has elected to participate
  1519. as a seller in the Merchandising Manager feature.
  1520. </documentation>
  1521. </annotation>
  1522. </element>
  1523. <element name="QualifiesForB2BVAT" type="xs:boolean"/>
  1524. <element ref="ns:SellerLevel"/>
  1525. <element ref="ns:SellerPaymentAddress" minOccurs="0"/>
  1526. <element name="SchedulingInfo" type="ns:SchedulingInfoType" minOccurs="0"/>
  1527. <element ref="ns:StoreOwner"/>
  1528. <element name="StoreURL" type="xs:anyURI" minOccurs="0"/>
  1529. </sequence>
  1530. </complexType>
  1531. <complexType name="FeeType">
  1532. <annotation>
  1533. <documentation>
  1534. Definition of an eBay Fee type.
  1535. </documentation>
  1536. </annotation>
  1537. <sequence>
  1538. <element name="Name" type="xs:string" minOccurs="0"/>
  1539. <element name="Fee" type="cc:AmountType" minOccurs="0"/>
  1540. </sequence>
  1541. </complexType>
  1542. <complexType name="FeesType">
  1543. <annotation>
  1544. <documentation>
  1545. Following are the current set of eBay fee types
  1546. AuctionLengthFee
  1547. BoldFee
  1548. BuyItNowFee
  1549. CategoryFeaturedFee
  1550. FeaturedFee
  1551. FeaturedGalleryFee
  1552. FixedPriceDurationFee
  1553. GalleryFee
  1554. GiftIconFee
  1555. HighLightFee
  1556. InsertionFee
  1557. ListingDesignerFee
  1558. ListingFee
  1559. PhotoDisplayFee
  1560. PhotoFee
  1561. ReserveFee
  1562. SchedulingFee
  1563. ThirtyDaysAucFee
  1564. Instances of this type could hold one or more supported types of fee.
  1565. </documentation>
  1566. </annotation>
  1567. <sequence>
  1568. <element name="Fee" type="ns:FeeType" maxOccurs="unbounded"/>
  1569. </sequence>
  1570. </complexType>
  1571. <complexType name="ShippingCarrierDetailsType">
  1572. <sequence>
  1573. <element name="CarrierShippingFee" type="cc:AmountType" minOccurs="0">
  1574. <annotation>
  1575. <documentation>
  1576. Calculated cost of shipping, based on shipping parameters and
  1577. selected shipping service. Only returned if ShippingType = 2
  1578. (i.e., calculated shipping rate).
  1579. </documentation>
  1580. </annotation>
  1581. </element>
  1582. <element ref="ns:InsuranceFee" minOccurs="0"/>
  1583. <element ref="ns:InsuranceOption" minOccurs="0"/>
  1584. <element name="PackagingHandlingCosts" type="cc:AmountType" minOccurs="0">
  1585. <annotation>
  1586. <documentation>
  1587. Optional fees a seller might assess for the shipping of the item.
  1588. </documentation>
  1589. </annotation>
  1590. </element>
  1591. <element name="ShippingRateErrorMessage" type="xs:string" minOccurs="0">
  1592. <annotation>
  1593. <documentation>
  1594. Describes any error message associated with the attempt
  1595. to calculate shipping rates. If there was no error, returns
  1596. "No Error" (without the quotation marks).
  1597. </documentation>
  1598. </annotation>
  1599. </element>
  1600. <element ref="ns:ShippingService">
  1601. <annotation>
  1602. <documentation>
  1603. is unique identified of shipping carrier, without this element the whole node makes no sence
  1604. </documentation>
  1605. </annotation>
  1606. </element>
  1607. </sequence>
  1608. </complexType>
  1609. <complexType name="CalculatedShippingRateType">
  1610. <sequence>
  1611. <element name="OriginatingPostalCode" type="xs:string" minOccurs="0">
  1612. <annotation>
  1613. <documentation>
  1614. Potal/zip code from where package will be shipped.
  1615. </documentation>
  1616. </annotation>
  1617. </element>
  1618. <element name="ShippingIrregular" type="xs:boolean" minOccurs="0">
  1619. <annotation>
  1620. <documentation>
  1621. Indicates an item that cannot go through the stamping machine
  1622. at the shipping service office (a value of True) and requires
  1623. special or fragile handling. Only returned if ShippingType = 2.
  1624. </documentation>
  1625. </annotation>
  1626. </element>
  1627. <element name="CarrierDetails" type="ns:ShippingCarrierDetailsType" minOccurs="0" maxOccurs="unbounded">
  1628. <annotation>
  1629. <documentation>
  1630. contains information about shipping fees per each shipping service chosen by the seller
  1631. </documentation>
  1632. </annotation>
  1633. </element>
  1634. <element name="ShippingPackage" type="ns:ShippingPackageCodeType" minOccurs="0">
  1635. <annotation>
  1636. <documentation>
  1637. May need to be moved into details - wait for George! The size of the package to be shipped. Possible values are:
  1638. None
  1639. Letter
  1640. Large envelope
  1641. USPS flat rate envelope
  1642. Package/thick envelope
  1643. USPS large package/oversize 1
  1644. Very large package/oversize 2
  1645. UPS Letter
  1646. </documentation>
  1647. </annotation>
  1648. </element>
  1649. <element name="WeightMajor" type="cc:MeasureType" minOccurs="0">
  1650. <annotation>
  1651. <documentation>
  1652. Shipping weight unit of measure (major). If unit of weight is kilogram
  1653. (i.e., metric system) this would be the exact weight value in kilogram
  1654. (i.e., complete decimal number, e.g., 2.23 kg). Only returned if
  1655. ShippingType is 2.
  1656. </documentation>
  1657. </annotation>
  1658. </element>
  1659. <element name="WeightMinor" type="cc:MeasureType" minOccurs="0">
  1660. <annotation>
  1661. <documentation>
  1662. Shipping weight unit of measure (minor). If unit of weight is in pounds and/or
  1663. ounces, this would be the exact weight value in ounces (i.e., complete
  1664. decimal number, e.g., 8.2 or 8.0 ounces). Only returned if ShippingType is 2.
  1665. </documentation>
  1666. </annotation>
  1667. </element>
  1668. </sequence>
  1669. </complexType>
  1670. <complexType name="FlatShippingRateType">
  1671. <sequence>
  1672. <element name="AdditionalShippingCosts" type="cc:AmountType" minOccurs="0">
  1673. <annotation>
  1674. <documentation>
  1675. Any additional shipping costs for the item.
  1676. </documentation>
  1677. </annotation>
  1678. </element>
  1679. <element name="FlatShippingHandlingCosts" type="cc:AmountType" minOccurs="0"/>
  1680. <element ref="ns:InsuranceFee" minOccurs="0"/>
  1681. <element ref="ns:InsuranceOption" minOccurs="0"/>
  1682. <element ref="ns:ShippingService" minOccurs="0"/>
  1683. </sequence>
  1684. </complexType>
  1685. <complexType name="SalesTaxType">
  1686. <sequence>
  1687. <element name="SalesTaxPercent" type="xs:float" minOccurs="0">
  1688. <annotation>
  1689. <documentation>
  1690. Amount of the sales tax to be collected for the transaction.
  1691. Sales tax is only for US.
  1692. </documentation>
  1693. </annotation>
  1694. </element>
  1695. <element name="SalesTaxState" type="xs:string" minOccurs="0">
  1696. <annotation>
  1697. <documentation>
  1698. Sales tax for the transaction, expressed as a percentage. Should
  1699. be empty for items listed on international sites (hence, this is
  1700. US-only element).
  1701. </documentation>
  1702. </annotation>
  1703. </element>
  1704. <element name="ShippingIncludedInTax" type="xs:boolean" minOccurs="0">
  1705. <annotation>
  1706. <documentation>
  1707. Indicates whether shipping is included in the tax. Applicable if
  1708. ShippingType = 1 or 2. This element is used for US-only.
  1709. </documentation>
  1710. </annotation>
  1711. </element>
  1712. </sequence>
  1713. </complexType>
  1714. <complexType name="ShippingDetailsType">
  1715. <annotation>
  1716. <documentation>
  1717. Specifies the shipping payment details.
  1718. </documentation>
  1719. </annotation>
  1720. <sequence>
  1721. <element name="AllowPaymentEdit" type="xs:boolean" minOccurs="0">
  1722. <annotation>
  1723. <documentation>
  1724. Indicates whether the buyer edited the payment amount.
  1725. </documentation>
  1726. </annotation>
  1727. </element>
  1728. <element name="CalculatedShippingRate" type="ns:CalculatedShippingRateType" minOccurs="0">
  1729. <annotation>
  1730. <documentation>
  1731. Calculated shipping rate details. If present, then the calculated shipping rate option was used.
  1732. </documentation>
  1733. </annotation>
  1734. </element>
  1735. <element name="ChangePaymentInstructions" type="xs:boolean" minOccurs="0">
  1736. <annotation>
  1737. <documentation>
  1738. Indicates whether the payment instructions are included (e.g., for updating the
  1739. details of a transaction).
  1740. </documentation>
  1741. </annotation>
  1742. </element>
  1743. <element name="FlatShippingRate" type="ns:FlatShippingRateType" minOccurs="0" maxOccurs="unbounded">
  1744. <annotation>
  1745. <documentation>
  1746. Flat shipping rate details. If present, then the flat shipping rate option was used.
  1747. </documentation>
  1748. </annotation>
  1749. </element>
  1750. <element name="InsuranceTotal" type="cc:AmountType" minOccurs="0">
  1751. <annotation>
  1752. <documentation>
  1753. Total cost of insurance for the transaction.
  1754. </documentation>
  1755. </annotation>
  1756. </element>
  1757. <element name="InsuranceWanted" type="xs:boolean" minOccurs="0">
  1758. <annotation>
  1759. <documentation>
  1760. Indicates whether buyer selected to have insurance.
  1761. </documentation>
  1762. </annotation>
  1763. </element>
  1764. <element name="PaymentInstructions" type="xs:string" minOccurs="0">
  1765. <annotation>
  1766. <documentation>
  1767. Payment instuctions.
  1768. </documentation>
  1769. </annotation>
  1770. </element>
  1771. <element name="SalesTax" type="ns:SalesTaxType" minOccurs="0">
  1772. <annotation>
  1773. <documentation>
  1774. Sales tax details. Sales tax applicable for only US sites.
  1775. For non-US sites this sub-element should not be used.
  1776. </documentation>
  1777. </annotation>
  1778. </element>
  1779. <element name="SellerPostalCode" type="xs:string" minOccurs="0">
  1780. <annotation>
  1781. <documentation>
  1782. Postal/Zip code from where the seller will ship the item.
  1783. </documentation>
  1784. </annotation>
  1785. </element>
  1786. </sequence>
  1787. </complexType>
  1788. <complexType name="SiteHostedPictureType">
  1789. <sequence>
  1790. <element name="PictureURL" type="xs:anyURI" minOccurs="0" maxOccurs="6">
  1791. <annotation>
  1792. <documentation>
  1793. URLs for item picture that are stored/hosted at eBay site.
  1794. </documentation>
  1795. </annotation>
  1796. </element>
  1797. <element name="PhotoDisplay" type="ns:PhotoDisplayCodeType" minOccurs="0">
  1798. <annotation>
  1799. <documentation>
  1800. Type of display for photos used for PhotoHosting slide show.
  1801. Here are display options:
  1802. None = No special Picture Services features.
  1803. SlideShow = Slideshow of multiple pictures.
  1804. SuperSize = Super-size format picture.
  1805. PicturePack = Picture Pack.
  1806. Default is 'None'.
  1807. </documentation>
  1808. </annotation>
  1809. </element>
  1810. <element name="GalleryType" type="ns:GalleryTypeCodeType" minOccurs="0">
  1811. <annotation>
  1812. <documentation>
  1813. This will be either "Featured" or "Gallery".
  1814. </documentation>
  1815. </annotation>
  1816. </element>
  1817. </sequence>
  1818. </complexType>
  1819. <complexType name="VendorHostedPictureType">
  1820. <sequence>
  1821. <element name="PictureURL" type="xs:anyURI" minOccurs="0">
  1822. <annotation>
  1823. <documentation>
  1824. URLs for item picture that are stored/hosted at eBay site.
  1825. </documentation>
  1826. </annotation>
  1827. </element>
  1828. <element name="GalleryURL" type="xs:anyURI" minOccurs="0">
  1829. <annotation>
  1830. <documentation>
  1831. URL for a picture for the gallery. If the GalleryFeatured
  1832. argument is true, a value must be supplied for either
  1833. the GalleryURL or the PictureURL argument.
  1834. In either case:
  1835. (a) If a URL is provided for only PictureURL, it is used
  1836. as the Gallery thumbnail.
  1837. (b) If a URL is provided for both GalleryURL and
  1838. PictureURL, then the picture indicated in GalleryURL
  1839. is used as the thumbnail.
  1840. The image used for the Gallery thumbnail (specified
  1841. in the GalleryURL or PictureURL argument) must be
  1842. in one of the graphics formats JPEG, BMP, TIF, or GIF.
  1843. </documentation>
  1844. </annotation>
  1845. </element>
  1846. <element name="GalleryType" type="ns:GalleryTypeCodeType" minOccurs="0">
  1847. <annotation>
  1848. <documentation>
  1849. This will be either "Featured" or "Gallery".
  1850. </documentation>
  1851. </annotation>
  1852. </element>
  1853. </sequence>
  1854. </complexType>
  1855. <complexType name="ValType">
  1856. <sequence>
  1857. <element name="ValueLiteral" type="xs:string"/>
  1858. </sequence>
  1859. <attribute name="ValueID" type="xs:string" use="optional"/>
  1860. </complexType>
  1861. <complexType name="AttributeType">
  1862. <annotation>
  1863. <documentation>
  1864. Specific physical attribute of an item.
  1865. </documentation>
  1866. </annotation>
  1867. <sequence>
  1868. <element name="Value" type="ns:ValType" maxOccurs="unbounded">
  1869. <annotation>
  1870. <documentation>
  1871. ValueList of the Attribute being described by the AttributeID.
  1872. </documentation>
  1873. </annotation>
  1874. </element>
  1875. </sequence>
  1876. <attribute name="AttributeID" type="xs:string">
  1877. <annotation>
  1878. <documentation>
  1879. Constant name of the attribute that identifies a
  1880. physical attribute within a set of characteristics
  1881. that describe something in a formalised way.
  1882. </documentation>
  1883. </annotation>
  1884. </attribute>
  1885. </complexType>
  1886. <complexType name="AttributeSetType">
  1887. <annotation>
  1888. <documentation>
  1889. AttributeSet.
  1890. </documentation>
  1891. </annotation>
  1892. <sequence>
  1893. <element name="Attribute" type="ns:AttributeType" maxOccurs="unbounded"/>
  1894. </sequence>
  1895. <attribute name="AttributeSetID" type="xs:string"/>
  1896. </complexType>
  1897. <complexType name="ListOfAttributeSetType">
  1898. <sequence>
  1899. <element name="AttributeSet" type="ns:AttributeSetType" maxOccurs="unbounded"/>
  1900. </sequence>
  1901. </complexType>
  1902. <complexType name="CategoryType">
  1903. <annotation>
  1904. <documentation>
  1905. Container for data on the primary category of listing.
  1906. </documentation>
  1907. </annotation>
  1908. <sequence>
  1909. <element name="AutoPayEnabled" type="xs:boolean" minOccurs="0"/>
  1910. <element name="B2BVATEnabled" type="xs:boolean" minOccurs="0"/>
  1911. <element name="CatalogEnabled" type="xs:boolean" minOccurs="0"/>
  1912. <element name="CategoryID" type="xs:string"/>
  1913. <element name="CategoryLevel" type="xs:int" minOccurs="0"/>
  1914. <element name="CategoryName" type="xs:string" minOccurs="0"/>
  1915. <element name="CategoryParentID" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
  1916. <element name="CategoryParentName" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
  1917. <element name="CSIDList" type="xs:string" minOccurs="0" maxOccurs="unbounded">
  1918. <annotation>
  1919. <documentation>
  1920. CSIDList is not present if Attributes enabled.
  1921. </documentation>
  1922. </annotation>
  1923. </element>
  1924. <element name="Expired" type="xs:boolean" minOccurs="0"/>
  1925. <element name="IntlAutosFixedCat" type="xs:boolean" minOccurs="0"/>
  1926. <element name="LeafCategory" type="xs:boolean" minOccurs="0"/>
  1927. <element name="Virtual" type="xs:boolean" minOccurs="0"/>
  1928. </sequence>
  1929. </complexType>
  1930. <complexType name="StorefrontType">
  1931. <annotation>
  1932. <documentation>
  1933. Contains the eBay Stores-specific item attributes
  1934. department number and store location. StorefrontInfo
  1935. is shown for any item that belongs to an eBay Store
  1936. owner, regardless of whether it is fixed price or
  1937. auction type. Returned as null for international
  1938. fixed price items.
  1939. </documentation>
  1940. </annotation>
  1941. <sequence>
  1942. <element ref="ns:StoreCategoryID">
  1943. <annotation>
  1944. <documentation>
  1945. 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
  1946. </documentation>
  1947. </annotation>
  1948. </element>
  1949. <element ref="ns:StoreURL" minOccurs="0">
  1950. <annotation>
  1951. <documentation>
  1952. 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
  1953. </documentation>
  1954. </annotation>
  1955. </element>
  1956. </sequence>
  1957. </complexType>
  1958. <complexType name="ListingDesignerType">
  1959. <annotation>
  1960. <documentation>
  1961. Identifies the Layout and the Theme template
  1962. associated with the item. in case of revision - all data can be min occur = 0
  1963. </documentation>
  1964. </annotation>
  1965. <sequence>
  1966. <element name="LayoutID" type="xs:int" minOccurs="0">
  1967. <annotation>
  1968. <documentation>
  1969. Identifies the Layout template associated with the item.
  1970. </documentation>
  1971. </annotation>
  1972. </element>
  1973. <element name="OptimalPictureSize" type="xs:boolean" minOccurs="0">
  1974. <annotation>
  1975. <documentation>
  1976. A value of true for OptimalPictureSize indicates that the picture
  1977. URL will be enlarged to fit description of the item.
  1978. </documentation>
  1979. </annotation>
  1980. </element>
  1981. <element name="ThemeID" type="xs:int" minOccurs="0">
  1982. <annotation>
  1983. <documentation>
  1984. Identifies the Theme template associated with the item.
  1985. </documentation>
  1986. </annotation>
  1987. </element>
  1988. </sequence>
  1989. </complexType>
  1990. <complexType name="CharityType">
  1991. <annotation>
  1992. <documentation>
  1993. Contains information about a Charity listing.in case of revision - all data can be min occur = 0
  1994. </documentation>
  1995. </annotation>
  1996. <sequence>
  1997. <element name="CharityName" type="xs:string" minOccurs="0"/>
  1998. <element name="CharityNumber" type="xs:int" minOccurs="0"/>
  1999. <element name="DonationPercent" type="xs:float" minOccurs="0"/>
  2000. </sequence>
  2001. </complexType>
  2002. <complexType name="SellingStatusType">
  2003. <annotation>
  2004. <documentation>
  2005. Contains the listed items price details which consists of
  2006. following information: BuyItNowPrice, ConvertedBuyItNowPrice,
  2007. ConvertedPrice, ConvertedStartPrice, CurrentPrice, MinimumToBid,
  2008. ReservePrice, and StartPrice. need to take in account get seller events when defining minoccurs = 0
  2009. </documentation>
  2010. </annotation>
  2011. <sequence>
  2012. <element name="BidCount" type="xs:int" minOccurs="0">
  2013. <annotation>
  2014. <documentation>
  2015. Number of bids placed so far against the item. Not
  2016. returned for International Fixed Price items.
  2017. </documentation>
  2018. </annotation>
  2019. </element>
  2020. <element name="BidIncrement" type="cc:AmountType" minOccurs="0">
  2021. <annotation>
  2022. <documentation>
  2023. Smallest amount a bid must be above the current high
  2024. bid. Not returned International Fixed Price items.
  2025. </documentation>
  2026. </annotation>
  2027. </element>
  2028. <element name="ConvertedCurrentPrice" type="cc:AmountType" minOccurs="0">
  2029. <annotation>
  2030. <documentation>
  2031. Converted current price of listed item.
  2032. </documentation>
  2033. </annotation>
  2034. </element>
  2035. <element name="CurrentPrice" type="cc:AmountType">
  2036. <annotation>
  2037. <documentation>
  2038. For auction-format listings, current minimum asking price
  2039. or the current highest bid for the item if bids have been
  2040. placed. Shows minimum bid if no bids have been placed
  2041. against the item. This field does not reflect the actual current
  2042. price of the item if it's a Type=7 or Type=9 (Fixed Price)
  2043. item and the price has been revised. (See StartPrice for
  2044. revised asking price.)
  2045. </documentation>
  2046. </annotation>
  2047. </element>
  2048. <element ref="ns:HighBidder" minOccurs="0">
  2049. <annotation>
  2050. <documentation>
  2051. Contains one User node representing the current high
  2052. bidder. GetItem returns a high bidder for auctions that have
  2053. ended and have a winning bidder. For Fixed Price listings,
  2054. in-progress auctions, or auction items that received no
  2055. bids, GetItem returns a HighBidder node with empty tags.
  2056. </documentation>
  2057. </annotation>
  2058. </element>
  2059. <element name="LeadCount" type="xs:int" minOccurs="0">
  2060. <annotation>
  2061. <documentation>
  2062. Applicable to ad-format items only. Indicates how many
  2063. leads to potential buyers are associated with this item.
  2064. For other item types (other than ad-format items), returns
  2065. a value of 0 (zero).
  2066. </documentation>
  2067. </annotation>
  2068. </element>
  2069. <element name="MinimumToBid" type="cc:AmountType" minOccurs="0">
  2070. <annotation>
  2071. <documentation>
  2072. Minimum acceptable bid for the item. Not returned for
  2073. International Fixed Price items.
  2074. </documentation>
  2075. </annotation>
  2076. </element>
  2077. <element name="QuantitySold" type="xs:int">
  2078. <annotation>
  2079. <documentation>
  2080. Number of items purchased so far. (Subtract from the value
  2081. returned in the Quantity field to calculate the number of items
  2082. remaining.)
  2083. </documentation>
  2084. </annotation>
  2085. </element>
  2086. <element name="ReserveMet" type="xs:boolean" minOccurs="0">
  2087. <annotation>
  2088. <documentation>
  2089. Returns true if the reserve price was met or no reserve
  2090. price was specified.
  2091. </documentation>
  2092. </annotation>
  2093. </element>
  2094. <element name="SecondChanceEligible" type="xs:boolean" minOccurs="0"/>
  2095. </sequence>
  2096. </complexType>
  2097. <complexType name="ReviseStatusType">
  2098. <annotation>
  2099. <documentation>
  2100. Contains the revise status information details (e.g., item properties
  2101. information). ths node contains system set data only - always output and always all data. no minccurs needed,
  2102. except for motors specific data, since it wil lnot be retruned for non motors items
  2103. </documentation>
  2104. </annotation>
  2105. <sequence>
  2106. <element name="ItemRevised" type="xs:boolean">
  2107. <annotation>
  2108. <documentation>
  2109. Indicates whether the item was revised since the auction started.
  2110. </documentation>
  2111. </annotation>
  2112. </element>
  2113. <element name="BuyItNowAdded" type="xs:boolean" minOccurs="0">
  2114. <annotation>
  2115. <documentation>
  2116. If true, indicates that a Buy It Now Price was added for
  2117. the item. Only returned for Motors items.
  2118. </documentation>
  2119. </annotation>
  2120. </element>
  2121. <element name="BuyItNowLowered" type="xs:boolean" minOccurs="0">
  2122. <annotation>
  2123. <documentation>
  2124. Replaces BinLowered as of API version 305. If true,
  2125. indicates that the Buy It Now Price was lowered for the
  2126. item. Only returned for Motors items.
  2127. </documentation>
  2128. </annotation>
  2129. </element>
  2130. <element name="ReserveLowered" type="xs:boolean" minOccurs="0">
  2131. <annotation>
  2132. <documentation>
  2133. If true, indicates that the Reserve Price was lowered for
  2134. the item. Only returned for Motors items.
  2135. </documentation>
  2136. </annotation>
  2137. </element>
  2138. <element name="ReserveRemoved" type="xs:boolean" minOccurs="0">
  2139. <annotation>
  2140. <documentation>
  2141. If true, indicates that the Reserve Price was removed
  2142. from the item. Only returned for eBay Motors items.
  2143. </documentation>
  2144. </annotation>
  2145. </element>
  2146. </sequence>
  2147. </complexType>
  2148. <complexType name="ListingDetailsType">
  2149. <annotation>
  2150. <documentation>
  2151. Contains the listed item details which consists of following information: .
  2152. </documentation>
  2153. </annotation>
  2154. <sequence>
  2155. <element name="Adult" type="xs:boolean" minOccurs="0">
  2156. <annotation>
  2157. <documentation>
  2158. </documentation>
  2159. </annotation>
  2160. </element>
  2161. <element name="BindingAuction" type="xs:boolean" minOccurs="0">
  2162. <annotation>
  2163. <documentation>
  2164. </documentation>
  2165. </annotation>
  2166. </element>
  2167. <element name="CheckoutEnabled" type="xs:boolean" minOccurs="0">
  2168. <annotation>
  2169. <documentation>
  2170. </documentation>
  2171. </annotation>
  2172. </element>
  2173. <element name="ConvertedBuyItNowPrice" type="cc:AmountType" minOccurs="0">
  2174. <annotation>
  2175. <documentation>
  2176. Converted value of the BuyItNowPrice in the currency
  2177. indicated by SiteCurrency. This value must be refreshed
  2178. every 24 hours to pick up the current conversion rates.
  2179. </documentation>
  2180. </annotation>
  2181. </element>
  2182. <element name="ConvertedStartPrice" type="cc:AmountType" minOccurs="0">
  2183. <annotation>
  2184. <documentation>
  2185. Converted value of the StartPrice field in the currency
  2186. indicated by SiteCurrency. This value must be refreshed
  2187. every 24 hours to pick up the current conversion rates.
  2188. </documentation>
  2189. </annotation>
  2190. </element>
  2191. <element name="ConvertedReservePrice" type="cc:AmountType" minOccurs="0">
  2192. <annotation>
  2193. <documentation>
  2194. Indicates the converted reserve price for a reserve auction. Returned
  2195. only if DetailLevel = 4. ReservePrice is only returned for auctions with
  2196. a reserve price where the user calling GetItem is the item's seller.
  2197. Returned as null for International Fixed Price items. For more information
  2198. on reserve price auctions, see http://pages.ebay.com/help/basics/f-format.html#1.
  2199. </documentation>
  2200. </annotation>
  2201. </element>
  2202. <element name="HasReservePrice" type="xs:boolean" minOccurs="0">
  2203. <annotation>
  2204. <documentation>
  2205. </documentation>
  2206. </annotation>
  2207. </element>
  2208. <element name="RegionName" type="xs:string" minOccurs="0">
  2209. <annotation>
  2210. <documentation>
  2211. </documentation>
  2212. </annotation>
  2213. </element>
  2214. <element name="RelistedItemID" type="ns:ItemIDType" minOccurs="0">
  2215. <annotation>
  2216. <documentation>
  2217. Indicates the new ItemID for a relisted item. When an item is
  2218. relisted, the old (expired) listing is annotated with the new
  2219. (relist) ItemID. This field only appears when the old listing is
  2220. retrieved.
  2221. </documentation>
  2222. </annotation>
  2223. </element>
  2224. <element name="SecondChanceOriginalItemID" type="ns:ItemIDType" minOccurs="0">
  2225. <annotation>
  2226. <documentation>
  2227. The ItemID for the original listing (i.e., OriginalItemID specific
  2228. to Second Chance Offer items).
  2229. </documentation>
  2230. </annotation>
  2231. </element>
  2232. <element name="StartTime" type="xs:dateTime" minOccurs="0">
  2233. <annotation>
  2234. <documentation>
  2235. Time stamp for the start of the listing (in GMT). For regular items,
  2236. StartTime is not sent in at listing time.
  2237. </documentation>
  2238. </annotation>
  2239. </element>
  2240. <element name="EndTime" type="xs:dateTime" minOccurs="0">
  2241. <annotation>
  2242. <documentation>
  2243. Time stamp for the end of the listing (in GMT).
  2244. </documentation>
  2245. </annotation>
  2246. </element>
  2247. <element name="ViewItemURL" type="xs:anyURI" minOccurs="0">
  2248. <annotation>
  2249. <documentation>
  2250. </documentation>
  2251. </annotation>
  2252. </element>
  2253. </sequence>
  2254. </complexType>
  2255. <complexType name="ItemType">
  2256. <sequence>
  2257. <element name="ApplicationData" type="xs:string" minOccurs="0">
  2258. <annotation>
  2259. <documentation>
  2260. Returns custom, application-specific data associated
  2261. with the item. The data in this field is stored with the item
  2262. in the items table at eBay, but is not used in any way by
  2263. eBay. Use ApplicationData to store such special information
  2264. as a part or SKU number. Maximum 32 characters in length.
  2265. </documentation>
  2266. </annotation>
  2267. </element>
  2268. <element name="ListOfAttributeSets" type="ns:ListOfAttributeSetType" minOccurs="0">
  2269. <annotation>
  2270. <documentation>
  2271. Carries one or more instances of the AttributeSet in a list.
  2272. </documentation>
  2273. </annotation>
  2274. </element>
  2275. <element name="AutoPay" type="xs:boolean" minOccurs="0">
  2276. <annotation>
  2277. <documentation>
  2278. If true (1), indicates that the seller requested immediate
  2279. payment for the item. False (0) if immediate payment was
  2280. not requested. (Does not indicate whether the item is
  2281. still a candidate for puchase via immediate payment.)
  2282. Only applicable for items listed on US and UK sites in
  2283. categories that support immediate payment, when seller
  2284. has a Premier or Business PayPal account.
  2285. </documentation>
  2286. </annotation>
  2287. </element>
  2288. <element name="BuyerProtection" type="ns:BuyerProtectionCodeType" minOccurs="0">
  2289. <annotation>
  2290. <documentation>
  2291. Indicates the status of the item's eligibility for the Buyer
  2292. Protection Program. Possible values:
  2293. ItemIneligible - Item is ineligible (e.g., category not applicable)
  2294. ItemEligible - Item is eligible per standard criteria
  2295. ItemMarkedIneligible - Item marked ineligible per special criteria (e.g., seller's account closed)
  2296. ItemMarkedIneligible - Item marked elegible per other criteria
  2297. Applicable for items listed to the US site and for the Parts
  2298. and Accessories category (6028) or Everything Else category
  2299. (10368) (or their subcategories) on the eBay Motors site.
  2300. </documentation>
  2301. </annotation>
  2302. </element>
  2303. <element name="BuyItNowPrice" type="cc:AmountType" minOccurs="0">
  2304. <annotation>
  2305. <documentation>
  2306. Amount a Buyer would need to bid to take advantage
  2307. of the Buy It Now feature. Not applicable to Fixed-Price
  2308. items (Type = 7 or 9) or AdFormat-type listings. For
  2309. Fixed-Price items, see StartPrice instead.
  2310. </documentation>
  2311. </annotation>
  2312. </element>
  2313. <element name="Charity" type="ns:CharityType" minOccurs="0">
  2314. <annotation>
  2315. <documentation>
  2316. Charity listing container.
  2317. </documentation>
  2318. </annotation>
  2319. </element>
  2320. <element ref="ns:Country" minOccurs="0">
  2321. <annotation>
  2322. <documentation>
  2323. 2-letter ISO 3166 Country Code.
  2324. </documentation>
  2325. </annotation>
  2326. </element>
  2327. <element name="CrossPromotion" type="ns:CrossPromotionsType" minOccurs="0">
  2328. <annotation>
  2329. <documentation>
  2330. CrossPromotions container, if applicable shows promoted items
  2331. </documentation>
  2332. </annotation>
  2333. </element>
  2334. <element ref="ns:Currency" minOccurs="0">
  2335. <annotation>
  2336. <documentation>
  2337. 3-letter ISO Currency Code.
  2338. </documentation>
  2339. </annotation>
  2340. </element>
  2341. <element name="Description" type="xs:string" minOccurs="0">
  2342. <annotation>
  2343. <documentation>
  2344. Item Description.
  2345. </documentation>
  2346. </annotation>
  2347. </element>
  2348. <element name="Escrow" type="ns:EscrowCodeType" minOccurs="0">
  2349. <annotation>
  2350. <documentation>
  2351. Online Escrow paid for by buyer or seller. Cannot use
  2352. with real estate auctions. Escrow is recommended for
  2353. for transactions over $500. Escrow service,
  2354. available via Escrow.com, protects both buyer and
  2355. seller by acting as a trusted third-party during the
  2356. transaction and managing the payment process
  2357. from start to finish. Also, if escrow by seller option used,
  2358. then for Motors, this means that Escrow will be
  2359. negotiated at the end of the auction.
  2360. </documentation>
  2361. </annotation>
  2362. </element>
  2363. <element name="GiftIcon" type="xs:int" minOccurs="0">
  2364. <annotation>
  2365. <documentation>
  2366. If set, a generic gift icon displays in the listing's
  2367. Title. GiftIcon must be set to to be able to use
  2368. GiftServices options (e.g., GiftExpressShipping,
  2369. GiftShipToRecipient, or GiftWrap).
  2370. </documentation>
  2371. </annotation>
  2372. </element>
  2373. <element name="GiftServices" type="ns:GiftServicesCodeType" minOccurs="0" maxOccurs="unbounded">
  2374. <annotation>
  2375. <documentation>
  2376. Gift service options offered by the seller of
  2377. the listed item.
  2378. </documentation>
  2379. </annotation>
  2380. </element>
  2381. <element name="HitCounter" type="ns:HitCounterCodeType" minOccurs="0">
  2382. <annotation>
  2383. <documentation>
  2384. Optional hit counter for the item's listing page. Possible
  2385. values are:
  2386. "NoHitCounter"
  2387. "HonestyStyle"
  2388. "GreenLED"
  2389. "Hidden"
  2390. </documentation>
  2391. </annotation>
  2392. </element>
  2393. <element ref="ns:ItemID" minOccurs="0">
  2394. <annotation>
  2395. <documentation>
  2396. The ID that uniquely identifies the item listing.
  2397. </documentation>
  2398. </annotation>
  2399. </element>
  2400. <element name="ListingDetails" type="ns:ListingDetailsType" minOccurs="0">
  2401. <annotation>
  2402. <documentation>
  2403. Includes listing details in terms of start and
  2404. end time of listing (in GMT) as well as other
  2405. details (e.g., orginal item for second chance,
  2406. converted start price, etc.).
  2407. </documentation>
  2408. </annotation>
  2409. </element>
  2410. <element name="ListingDesigner" type="ns:ListingDesignerType" minOccurs="0">
  2411. <annotation>
  2412. <documentation>
  2413. When an item is first listed (using AddItem), a Layout template
  2414. or a Theme template (or both) can be assigned to the item.
  2415. A Layout template is assigned to a new item by specifying
  2416. the Layout template ID (in the AddItem input argument
  2417. LayoutID). Similarly, a Theme template is assigned to the
  2418. item using the ThemeID argument.
  2419. </documentation>
  2420. </annotation>
  2421. </element>
  2422. <element ref="ns:ListingDuration" minOccurs="0">
  2423. <annotation>
  2424. <documentation>
  2425. Describes the number of days the auction will be active.
  2426. </documentation>
  2427. </annotation>
  2428. </element>
  2429. <element name="ListingEnhancement" type="ns:ListingEnhancementsCodeType" minOccurs="0" maxOccurs="unbounded">
  2430. <annotation>
  2431. <documentation>
  2432. Describes the types of enhancment supported
  2433. for the item's listing.
  2434. </documentation>
  2435. </annotation>
  2436. </element>
  2437. <element name="ListingType" type="ns:ListingTypeCodeType" minOccurs="0">
  2438. <annotation>
  2439. <documentation>
  2440. Describes the type of listing for the item a seller
  2441. has chosen (e.g., Chinese, Dutch, FixedPrice, etc.).
  2442. </documentation>
  2443. </annotation>
  2444. </element>
  2445. <element name="Location" type="xs:string" minOccurs="0">
  2446. <annotation>
  2447. <documentation>
  2448. Indicates the geographical location of the item.
  2449. </documentation>
  2450. </annotation>
  2451. </element>
  2452. <element name="PartnerCode" type="xs:string" minOccurs="0">
  2453. <annotation>
  2454. <documentation>
  2455. Needed for add item only for partners.
  2456. </documentation>
  2457. </annotation>
  2458. </element>
  2459. <element name="PartnerName" type="xs:string" minOccurs="0">
  2460. <annotation>
  2461. <documentation>
  2462. Needed for add item only for partners.
  2463. </documentation>
  2464. </annotation>
  2465. </element>
  2466. <element ref="ns:PaymentMethods" minOccurs="0" maxOccurs="unbounded">
  2467. <annotation>
  2468. <documentation>
  2469. List of payment methods accepted by a seller from a buyer for
  2470. a (checkout) transaction.
  2471. </documentation>
  2472. </annotation>
  2473. </element>
  2474. <element name="PayPalEmailAddress" type="xs:string" minOccurs="0">
  2475. <annotation>
  2476. <documentation>
  2477. Valid PayPal e-mail address if seller has chosen PayPal
  2478. as a payment method for the listed item.
  2479. </documentation>
  2480. </annotation>
  2481. </element>
  2482. <element name="PrimaryCategory" type="ns:CategoryType" minOccurs="0">
  2483. <annotation>
  2484. <documentation>
  2485. Container for data on the primary category of listing.
  2486. </documentation>
  2487. </annotation>
  2488. </element>
  2489. <element name="PrivateListing" type="xs:boolean" minOccurs="0">
  2490. <annotation>
  2491. <documentation>
  2492. Private auction. Not applicable to Fixed Price items.
  2493. </documentation>
  2494. </annotation>
  2495. </element>
  2496. <element name="Quantity" type="xs:int" minOccurs="0">
  2497. <annotation>
  2498. <documentation>
  2499. Number of items being sold in the auction.
  2500. </documentation>
  2501. </annotation>
  2502. </element>
  2503. <element ref="ns:RegionID" minOccurs="0">
  2504. <annotation>
  2505. <documentation>
  2506. Region where the item is listed. See Region Table for values.
  2507. If the item is listed with a Region of 0 (zero), then this return
  2508. field denotes no region association with the item, meaning
  2509. that it is not listing the item regionally.
  2510. </documentation>
  2511. </annotation>
  2512. </element>
  2513. <element name="RelistLink" type="xs:boolean" minOccurs="0">
  2514. <annotation>
  2515. <documentation>
  2516. If true, creates a link from the old listing for the item to the new
  2517. relist page, which accommodates users who might still look for
  2518. the item under its old item ID. Also adds the relist ID to the old
  2519. listing's record in the eBay database, which can be returned by
  2520. calling GetItem for the old ItemId. If your application creates the
  2521. listing page for the user, you need to add the relist link option to
  2522. your application for your users.
  2523. </documentation>
  2524. </annotation>
  2525. </element>
  2526. <element name="ReservePrice" type="cc:AmountType" minOccurs="0">
  2527. <annotation>
  2528. <documentation>
  2529. Indicates the reserve price for a reserve auction. Returned
  2530. only if DetailLevel = 4. ReservePrice is only returned for
  2531. auctions with a reserve price where the user calling GetItem
  2532. is the item's seller. Returned as null for International Fixed
  2533. Price items. For more information on reserve price auctions,
  2534. see http://pages.ebay.com/help/basics/f-format.html#1.
  2535. </documentation>
  2536. </annotation>
  2537. </element>
  2538. <element ref="ns:ReviseStatus" minOccurs="0">
  2539. <annotation>
  2540. <documentation>
  2541. Revise Status contains information about the item being
  2542. revised.
  2543. </documentation>
  2544. </annotation>
  2545. </element>
  2546. <element name="ScheduleTime" type="xs:dateTime" minOccurs="0"/>
  2547. <element name="SecondaryCategory" type="ns:CategoryType" minOccurs="0">
  2548. <annotation>
  2549. <documentation>
  2550. Container for data on the secondary category of listing.
  2551. Secondary category is optional.
  2552. </documentation>
  2553. </annotation>
  2554. </element>
  2555. <element name="SiteHostedPicture" type="ns:SiteHostedPictureType" minOccurs="0">
  2556. <annotation>
  2557. <documentation>
  2558. Item picture information for pictures hosted at eBay site.
  2559. </documentation>
  2560. </annotation>
  2561. </element>
  2562. <element ref="ns:Seller" minOccurs="0">
  2563. <annotation>
  2564. <documentation>
  2565. Seller user.
  2566. </documentation>
  2567. </annotation>
  2568. </element>
  2569. <element ref="ns:SellingStatus" minOccurs="0">
  2570. <annotation>
  2571. <documentation>
  2572. Container for for selling status information (e.g., BidCount,
  2573. BidIncrement, HighBidder, MinimimumToBid, etc).
  2574. </documentation>
  2575. </annotation>
  2576. </element>
  2577. <element name="ShippingOption" type="ns:ShippingOptionCodeType" minOccurs="0">
  2578. <annotation>
  2579. <documentation>
  2580. Specifies where the seller is willing to ship the item.
  2581. Default "SiteOnly". Valid values are:
  2582. SiteOnly (the default)
  2583. WorldWide
  2584. SitePlusRegions
  2585. WillNotShip
  2586. If SitePlusRegions is selected, then at least one
  2587. regions argument (ShipToNorthAmerica, ShipToEurope,
  2588. etc.) must also be set.
  2589. </documentation>
  2590. </annotation>
  2591. </element>
  2592. <element ref="ns:ShippingDetails" minOccurs="0">
  2593. <annotation>
  2594. <documentation>
  2595. Contains the shipping payment related information for the
  2596. listed item.
  2597. </documentation>
  2598. </annotation>
  2599. </element>
  2600. <element ref="ns:ShippingRegions" minOccurs="0" maxOccurs="unbounded">
  2601. <annotation>
  2602. <documentation>
  2603. Regions that seller will ship to.
  2604. </documentation>
  2605. </annotation>
  2606. </element>
  2607. <element name="ShippingTerms" type="ns:ShippingTermsCodeType" minOccurs="0">
  2608. <annotation>
  2609. <documentation>
  2610. Describes who pays for the delivery of an item (e.g., buyer
  2611. or seller).
  2612. </documentation>
  2613. </annotation>
  2614. </element>
  2615. <element ref="ns:Site" minOccurs="0">
  2616. <annotation>
  2617. <documentation>
  2618. eBay site on which item is listed.
  2619. </documentation>
  2620. </annotation>
  2621. </element>
  2622. <element name="StartPrice" type="cc:AmountType" minOccurs="0">
  2623. <annotation>
  2624. <documentation>
  2625. Starting price for the item. For Type=7 or Type=9 (Fixed Price)
  2626. items, if the item price (MinimumBid) is revised, this field
  2627. returns the new price.
  2628. </documentation>
  2629. </annotation>
  2630. </element>
  2631. <element name="Storefront" type="ns:StorefrontType" minOccurs="0">
  2632. <annotation>
  2633. <documentation>
  2634. Storefront is shown for any item that
  2635. belongs to an eBay Store owner, regardless of
  2636. whether it is fixed price or auction type. Not
  2637. returned for International Fixed Price items.
  2638. </documentation>
  2639. </annotation>
  2640. </element>
  2641. <element name="SubTitle" type="xs:string" minOccurs="0">
  2642. <annotation>
  2643. <documentation>
  2644. Subtitle to use in addition to the title. Provides more keywords when buyers search in titles and descriptions.
  2645. </documentation>
  2646. </annotation>
  2647. </element>
  2648. <element name="TimeLeft" type="xs:duration" minOccurs="0">
  2649. <annotation>
  2650. <documentation>
  2651. Time until the the end of the listing (e.g., the amount of time left
  2652. in an active auction).
  2653. </documentation>
  2654. </annotation>
  2655. </element>
  2656. <element name="Title" type="xs:string" minOccurs="0">
  2657. <annotation>
  2658. <documentation>
  2659. Name of the item as it appears for auctions.
  2660. </documentation>
  2661. </annotation>
  2662. </element>
  2663. <element ref="ns:UUID" minOccurs="0">
  2664. <annotation>
  2665. <documentation>
  2666. Universally unique constraint tag. The UUID is unique to a category.
  2667. </documentation>
  2668. </annotation>
  2669. </element>
  2670. <element name="VATDetails" type="ns:VATDetailsType" minOccurs="0">
  2671. <annotation>
  2672. <documentation>
  2673. VAT info container.
  2674. </documentation>
  2675. </annotation>
  2676. </element>
  2677. <element name="VendorHostedPicture" type="ns:VendorHostedPictureType" minOccurs="0">
  2678. <annotation>
  2679. <documentation>
  2680. Item picture information for pictures hosted at vendor (i.e., remote) site.
  2681. </documentation>
  2682. </annotation>
  2683. </element>
  2684. </sequence>
  2685. </complexType>
  2686. <complexType name="TransactionsType">
  2687. <annotation>
  2688. <documentation>
  2689. Contains information about multiple individual transations.
  2690. </documentation>
  2691. </annotation>
  2692. <sequence>
  2693. <element ref="ns:Transaction" maxOccurs="unbounded"/>
  2694. </sequence>
  2695. </complexType>
  2696. <complexType name="TransactionType">
  2697. <annotation>
  2698. <documentation>
  2699. Contains information about a single transaction. A transaction contains information
  2700. about the sale of a particular item. The system creates a transaction when a buyer
  2701. has made a purchase (Fixed Price items) or is the winning bidder (BIN and auction
  2702. items). A listing can be associated with one or more transactions in these cases:
  2703. Multi-Item Fixed Price Listings
  2704. Dutch Auction Listings
  2705. A listing is associated with a single transaction in these cases:
  2706. Single-Item Fixed Price Listings
  2707. Single-Item Auction Listings
  2708. </documentation>
  2709. </annotation>
  2710. <sequence>
  2711. <element ref="ns:AmountPaid" minOccurs="0">
  2712. <annotation>
  2713. <documentation>
  2714. The amount the buyer paid for the item or agreed to pay,
  2715. depending on how far into the checkout process the item is.
  2716. If the seller allowed the buyer to change the item total, the buyer
  2717. is able to change the total until the time that the transaction's
  2718. status moves to Complete. Determine whether the buyer
  2719. changed the amount by calling GetSellerTransactions or
  2720. GetSellerTransactions and comparing the AmountPaid value
  2721. to what the seller expected. For Motors items, AmountPaid is
  2722. the amount paid by the buyer for the deposit.
  2723. </documentation>
  2724. </annotation>
  2725. </element>
  2726. <element name="Buyer" type="ns:UserType" minOccurs="0">
  2727. <annotation>
  2728. <documentation>
  2729. Container for buyer data.
  2730. </documentation>
  2731. </annotation>
  2732. </element>
  2733. <element ref="ns:ShippingDetails" minOccurs="0">
  2734. <annotation>
  2735. <documentation>
  2736. Includes shipping payment data.
  2737. </documentation>
  2738. </annotation>
  2739. </element>
  2740. <element name="ConvertedAmountPaid" type="cc:AmountType" minOccurs="0">
  2741. <annotation>
  2742. <documentation>
  2743. Value returned in the Transaction/AmountPaid element, converted
  2744. to the currency indicated by SiteCurrency.
  2745. </documentation>
  2746. </annotation>
  2747. </element>
  2748. <element name="ConvertedTransactionPrice" type="cc:AmountType" minOccurs="0">
  2749. <annotation>
  2750. <documentation>
  2751. Value returned in the Transaction/TransactionPrice element,
  2752. converted to the currency indicated by SiteCurrency.
  2753. </documentation>
  2754. </annotation>
  2755. </element>
  2756. <element name="CreatedDate" type="xs:dateTime" minOccurs="0">
  2757. <annotation>
  2758. <documentation>
  2759. For fixed-price, Stores, and BIN items indicates when the
  2760. purchase (or BIN) occurred. For all other item types indicates
  2761. when the transaction was created (the time when checkout
  2762. was initiated).
  2763. </documentation>
  2764. </annotation>
  2765. </element>
  2766. <element name="DepositType" type="ns:DepositTypeCodeType" minOccurs="0">
  2767. <annotation>
  2768. <documentation>
  2769. Deposit type for Motors items. If item is not a Motors item,
  2770. then returns a DepositType of None. Possible values:
  2771. None
  2772. Other Method
  2773. Fast Deposit
  2774. </documentation>
  2775. </annotation>
  2776. </element>
  2777. <element name="Item" type="ns:ItemType" minOccurs="0">
  2778. <annotation>
  2779. <documentation>
  2780. Item info associated with the transaction.
  2781. </documentation>
  2782. </annotation>
  2783. </element>
  2784. <element name="QuantityPurchased" type="xs:int" minOccurs="0">
  2785. <annotation>
  2786. <documentation>
  2787. Contains the number of individual items the buyer purchased in
  2788. the transaction.
  2789. </documentation>
  2790. </annotation>
  2791. </element>
  2792. <element name="ShippingHandlingTotal" type="cc:AmountType" minOccurs="0">
  2793. <annotation>
  2794. <documentation>
  2795. Shipping cost totals shown to user (for both flat and calculated
  2796. rates).
  2797. </documentation>
  2798. </annotation>
  2799. </element>
  2800. <element name="Status" type="ns:TransactionStatusType" minOccurs="0">
  2801. <annotation>
  2802. <documentation>
  2803. Container node for transaction status data.
  2804. </documentation>
  2805. </annotation>
  2806. </element>
  2807. <element ref="ns:TransactionID" minOccurs="0">
  2808. <annotation>
  2809. <documentation>
  2810. Unique identifier for a transaction. Returns 0 when Type=1
  2811. (Chinese auction). Typically, an ItemID and a TransactionID
  2812. uniquely identify a checkout transaction.
  2813. </documentation>
  2814. </annotation>
  2815. </element>
  2816. <element ref="ns:AuthorizationID">
  2817. <annotation>
  2818. <documentation>
  2819. Unique identifier for an authorization.
  2820. </documentation>
  2821. </annotation>
  2822. </element>
  2823. <element name="TransactionPrice" type="cc:AmountType" minOccurs="0">
  2824. <annotation>
  2825. <documentation>
  2826. Price of the item, before shipping and sales tax. For Motors,
  2827. TransactionPrice is the deposit amount.
  2828. </documentation>
  2829. </annotation>
  2830. </element>
  2831. <element name="VATPercent" type="xs:decimal" minOccurs="0">
  2832. <annotation>
  2833. <documentation>
  2834. VAT rate for the item, if the item price includes the VAT rate.
  2835. Specify the VATPercent if you want include the net price in
  2836. addition to the gross price in the listing. VAT rates vary
  2837. depending on the item and on the user's country of residence;
  2838. therefore a business seller is responsible for entering the
  2839. correct VAT rate (it will not be calculated by eBay).
  2840. </documentation>
  2841. </annotation>
  2842. </element>
  2843. </sequence>
  2844. </complexType>
  2845. <simpleType name="UserIDType">
  2846. <restriction base="xs:string">
  2847. <maxLength value="127"/>
  2848. </restriction>
  2849. </simpleType>
  2850. <complexType name="PaymentMeansType">
  2851. <sequence>
  2852. <element name="TypeCodeID" type="ns:SellerPaymentMethodCodeType"/>
  2853. </sequence>
  2854. </complexType>
  2855. <complexType name="PaymentType">
  2856. <sequence>
  2857. <element name="PaymentMeans" type="ns:PaymentMeansType"/>
  2858. </sequence>
  2859. </complexType>
  2860. <complexType name="TransactionStatusType">
  2861. <sequence>
  2862. <element name="eBayPaymentStatus" type="xs:int" minOccurs="0">
  2863. <annotation>
  2864. <documentation>
  2865. Indicates the success or failure of an eBay Online Payment for
  2866. the transaction. If the payment failed, the value returned indicates
  2867. the reason for the failure. Possible values:
  2868. 0 = No payment failure.
  2869. 3 = Buyer's eCheck bounced.
  2870. 4 = Buyer's credit card failed.
  2871. 5 = Buyer failed payment as reported by seller.
  2872. 7 = Payment from buyer to seller is in PayPal process, but has not yet been completed.
  2873. </documentation>
  2874. </annotation>
  2875. </element>
  2876. <element name="IncompleteState" type="xs:int" minOccurs="0">
  2877. <annotation>
  2878. <documentation>
  2879. Indicates the current state of the checkout process for the transaction. Possible values:
  2880. 0 = Checkout complete.
  2881. 1 = Checkout incomplete. No details specified.
  2882. 2 = Buyer requests total.
  2883. 3 = Seller responded to buyer's request.
  2884. </documentation>
  2885. </annotation>
  2886. </element>
  2887. <element name="LastTimeModified" type="xs:dateTime" minOccurs="0">
  2888. <annotation>
  2889. <documentation>
  2890. Indicates last date and time checkout status or incomplete state was updated
  2891. (in GMT).
  2892. </documentation>
  2893. </annotation>
  2894. </element>
  2895. <element name="PaymentMethodUsed" type="ns:BuyerPaymentMethodCodeType" minOccurs="0">
  2896. <annotation>
  2897. <documentation>
  2898. Payment method used by the buyer. (See BuyerPaymentCodeList/Type).
  2899. </documentation>
  2900. </annotation>
  2901. </element>
  2902. <element name="StatusIs" type="xs:int" minOccurs="0">
  2903. <annotation>
  2904. <documentation>
  2905. Indicates whether the transaction process complete or incomplete.
  2906. Possible values:
  2907. 1 = Incomplete
  2908. 2 = Complete
  2909. </documentation>
  2910. </annotation>
  2911. </element>
  2912. </sequence>
  2913. </complexType>
  2914. <complexType name="UserType">
  2915. <sequence>
  2916. <element name="AboutMePage" type="xs:boolean" minOccurs="0"/>
  2917. <element name="EAISToken" type="xs:string" minOccurs="0"/>
  2918. <element ref="ns:Email"/>
  2919. <element ref="ns:FeedbackScore" minOccurs="0">
  2920. <annotation>
  2921. <documentation>
  2922. Feedback scores are a quantitative expression of the desirability of dealing
  2923. with that person as a Buyer or a Seller in auction transactions. Each
  2924. auction transaction can result in one feedback entry for a given user
  2925. (the Buyer can leave one feedback about the Seller and the Seller can leave
  2926. one feedback about the Buyer). That one feedback can be positive, negative,
  2927. or neutral. The aggregated feedback counts for a particular user represent
  2928. that user's overall feedback score (referred to as a "feedback rating" on the
  2929. eBay site). This rating is commonly expressed as the eBay Feedback score
  2930. for the user.
  2931. </documentation>
  2932. </annotation>
  2933. </element>
  2934. <element name="FeedbackPrivate" type="xs:boolean" minOccurs="0"/>
  2935. <element name="FeedbackRatingStar" type="ns:FeedbackRatingStarCodeType" minOccurs="0"/>
  2936. <element name="IDVerified" type="xs:boolean" minOccurs="0"/>
  2937. <element name="NewUser" type="xs:boolean" minOccurs="0"/>
  2938. <element ref="ns:RegistrationAddress" minOccurs="0"/>
  2939. <element name="RegistrationDate" type="xs:dateTime" minOccurs="0"/>
  2940. <element ref="ns:Site" minOccurs="0"/>
  2941. <element name="Status" type="ns:UserStatusCodeType" minOccurs="0"/>
  2942. <element ref="ns:UserID" minOccurs="0"/>
  2943. <element name="UserIDChanged" type="xs:boolean" minOccurs="0"/>
  2944. <element name="UserIDLastChanged" type="xs:dateTime" minOccurs="0"/>
  2945. <element name="VATStatus" type="ns:VATStatusCodeType" minOccurs="0">
  2946. <annotation>
  2947. <documentation>
  2948. If present, indicates whether or not the user is subject to VAT.
  2949. Users who have registered with eBay as VAT-exempt are not
  2950. subject to VAT. See Value-Added Tax (VAT). Not returned for
  2951. users whose country of residence is outside the EU.
  2952. Possible values for the user's status:
  2953. 2 = Residence in an EU country but user registered as VAT-exempt
  2954. 3 = Residence in an EU country and user not registered as VAT-exempt
  2955. </documentation>
  2956. </annotation>
  2957. </element>
  2958. <element name="BuyerInfo" type="ns:BuyerType" minOccurs="0"/>
  2959. <element name="SellerInfo" type="ns:SellerType" minOccurs="0"/>
  2960. </sequence>
  2961. </complexType>
  2962. <complexType name="VATDetailsType">
  2963. <annotation>
  2964. <documentation>
  2965. Contains information required To list a business item.
  2966. BusinessSeller - only for add item, the RestrictedToBusiness and VATPercent for both get and add,
  2967. for revise all must be optional
  2968. </documentation>
  2969. </annotation>
  2970. <sequence>
  2971. <element name="BusinessSeller" type="xs:boolean" minOccurs="0"/>
  2972. <element name="RestrictedToBusiness" type="xs:boolean" minOccurs="0"/>
  2973. <element name="VATPercent" type="xs:float" minOccurs="0"/>
  2974. </sequence>
  2975. </complexType>
  2976. <complexType name="SchedulingInfoType">
  2977. <annotation>
  2978. <documentation>
  2979. Contains information for Scheduling limits for the user. All dtails must be present,unless we will have revise call one day,
  2980. just in case we might let's make min occur = 0
  2981. </documentation>
  2982. </annotation>
  2983. <sequence>
  2984. <element name="MaxScheduledMinutes" type="xs:int" minOccurs="0"/>
  2985. <element name="MinScheduledMinutes" type="xs:int" minOccurs="0"/>
  2986. <element name="MaxScheduledItems" type="xs:int" minOccurs="0"/>
  2987. </sequence>
  2988. </complexType>
  2989. <element name="AccountCode" type="xs:string"/>
  2990. <element name="AccountSummary" type="ns:AccountSummaryType"/>
  2991. <element name="AmountPaid" type="cc:AmountType"/>
  2992. <element name="AmountPastDue" type="cc:AmountType"/>
  2993. <element name="Balance" type="cc:AmountType"/>
  2994. <element name="Buyer" type="ns:UserType"/>
  2995. <element name="Category" type="ns:CategoryType"/>
  2996. <element name="CheckoutEnabled" type="xs:boolean"/>
  2997. <element name="CurrentBalance" type="cc:AmountType"/>
  2998. <element name="FeedbackScore" type="xs:int"/>
  2999. <element name="Fees" type="ns:FeesType"/>
  3000. <element name="HighBidder" type="ns:UserType"/>
  3001. <element name="InsuranceFee" type="cc:AmountType">
  3002. <annotation>
  3003. <documentation>
  3004. Amount of insurance. Applicable if ShippingType is
  3005. Flat shipping rate orCalculated shipping rate.
  3006. </documentation>
  3007. </annotation>
  3008. </element>
  3009. <element name="InsuranceOption" type="ns:InsuranceOptionCodeType">
  3010. <annotation>
  3011. <documentation>
  3012. Indicates whether insurance fee is required. Possible values:
  3013. Insurance not offered.
  3014. Insurance optional.
  3015. Insurance required.
  3016. Insurance included in Shipping and Handling costs.
  3017. Applicable if ShippingType is Flat shipping rate or
  3018. Calculated shipping rate.
  3019. </documentation>
  3020. </annotation>
  3021. </element>
  3022. <element name="Item" type="ns:ItemType"/>
  3023. <element name="ItemID" type="ns:ItemIDType"/>
  3024. <element name="ListingDuration" type="ns:ListingDurationCodeType"/>
  3025. <element name="PaymentMeans" type="ns:PaymentMeansType"/>
  3026. <element name="PaymentMethods" type="ns:BuyerPaymentMethodCodeType"/>
  3027. <element name="PaymentType" type="ns:PaymentType"/>
  3028. <element name="Region" type="xs:string"/>
  3029. <element name="RegionID" type="xs:string"/>
  3030. <element name="RegistrationAddress" type="ns:AddressType"/>
  3031. <element name="ReviseStatus" type="ns:ReviseStatusType"/>
  3032. <element name="Seller" type="ns:UserType"/>
  3033. <element name="SellerLevel" type="ns:SellerLevelCodeType"/>
  3034. <element name="SellingStatus" type="ns:SellingStatusType"/>
  3035. <element name="ShippingService" type="ns:ShippingServiceCodeType">
  3036. <annotation>
  3037. <documentation>
  3038. Shipping carrier for the item. Possible values are:
  3039. UPS Ground
  3040. UPS 3rd Day
  3041. UPS 2nd Day
  3042. UPS Next Day
  3043. USPS Priority
  3044. USPS Parcel
  3045. USPS Media
  3046. USPS First Class
  3047. </documentation>
  3048. </annotation>
  3049. </element>
  3050. <element name="Site" type="ns:SiteCodeType"/>
  3051. <element name="StoreCategoryID" type="xs:int">
  3052. <annotation>
  3053. <documentation>
  3054. Custom categories for subdividing the items
  3055. within an eBay Store. Store owners can create
  3056. up to 12 custom categories for their stores.
  3057. (One Store category cannot be customized
  3058. and retains the value of "Other") If specified,
  3059. must be number between 0 and 12.
  3060. 0=Not an eBay Store item
  3061. 1=Other
  3062. 2=Category 1
  3063. 3=Category 2
  3064. ...
  3065. 11=Category 10
  3066. 12=Category 11
  3067. Returned as null for international fixed priced
  3068. item.
  3069. </documentation>
  3070. </annotation>
  3071. </element>
  3072. <element name="StoreOwner" type="xs:boolean"/>
  3073. <element name="StoreURL" type="xs:anyURI">
  3074. <annotation>
  3075. <documentation>
  3076. URL pointing to the seller's eBay Store page.
  3077. Returned as null for International Fixed Price items.
  3078. This URL follows the format below, where "####"
  3079. is replaced by the seller's eBay Stores ID (that
  3080. uniquely identifies the eBay Store).
  3081. http://www.ebaystores.com/id=####
  3082. </documentation>
  3083. </annotation>
  3084. </element>
  3085. <complexType name="ItemArrayType">
  3086. <sequence>
  3087. <element ref="ns:Item" minOccurs="0" maxOccurs="unbounded"/>
  3088. </sequence>
  3089. </complexType>
  3090. <element name="ItemArray" type="ns:ItemArrayType"/>
  3091. <complexType name="CategoryArrayType">
  3092. <sequence>
  3093. <element ref="ns:Category" minOccurs="0" maxOccurs="unbounded"/>
  3094. </sequence>
  3095. </complexType>
  3096. <element name="CategoryArray" type="ns:CategoryArrayType"/>
  3097. <complexType name="PaginationType">
  3098. <sequence>
  3099. <element name="EntriesPerPage" type="xs:int" minOccurs="0"/>
  3100. <element name="PageNumber" type="xs:int" minOccurs="0"/>
  3101. </sequence>
  3102. </complexType>
  3103. <complexType name="ModifiedFieldType">
  3104. <sequence>
  3105. <element name="Field" type="xs:string" minOccurs="0"/>
  3106. <element name="ModifyType" type="ns:ModifyCodeType" minOccurs="0"/>
  3107. </sequence>
  3108. </complexType>
  3109. <complexType name="PaginationResultType">
  3110. <sequence>
  3111. <element name="TotalNumberOfPages" type="xs:int" minOccurs="0"/>
  3112. <element name="TotalNumberOfEntries" type="xs:int" minOccurs="0"/>
  3113. </sequence>
  3114. </complexType>
  3115. <element name="Pagination" type="ns:PaginationType"/>
  3116. <element name="PaginationResult" type="ns:PaginationResultType"/>
  3117. <element name="ShippingAddress" type="ns:AddressType"/>
  3118. <element name="ShippingInfo" type="ns:ShippingInfoType"/>
  3119. <element name="TaxInfo" type="ns:TaxInfoType"/>
  3120. <element name="Error" type="ns:ErrorType"/>
  3121. <element name="ThreeDSecureRequest" type="ns:ThreeDSecureRequestType"/>
  3122. <element name="CreditCardInfo" type="ns:CreditCardDetailsType"/>
  3123. <element name="SellerPaymentAddress" type="ns:AddressType"/>
  3124. <element name="ShippingRegions" type="ns:ShippingRegionCodeType"/>
  3125. <element name="ShippingDetails" type="ns:ShippingDetailsType"/>
  3126. <element name="ShippingTerm" type="ns:ShippingTermsCodeType"/>
  3127. <element name="Transaction" type="ns:TransactionType"/>
  3128. <element name="Transactions" type="ns:TransactionsType"/>
  3129. <element name="TransactionID" type="xs:string"/>
  3130. <element name="EbayTransactionID" type="xs:string"/>
  3131. <element name="AuthorizationID" type="xs:string"/>
  3132. <element name="UserID" type="ns:UserIDType"/>
  3133. <element name="User" type="ns:UserType"/>
  3134. <annotation>
  3135. <documentation xml:lang="en">
  3136. Inclusion of all supported eBay Business Language (eBL) Code Lists.
  3137. This schema definition file contains specification for:
  3138. 1) eBay Business Langauge (eBL) Abstract Request and Response Message
  3139. which will be used to construct payloads for various applications;
  3140. 2) Re-useable error components of the eBL that would be used to communicate
  3141. application-level error messages back to the client application. These application
  3142. error messages may be due to a problem detected while processing the
  3143. request message.
  3144. 3) Other utility components needed by various eBay buying, selling, and payment
  3145. applications, e.g., address type and element.
  3146. </documentation>
  3147. </annotation>
  3148. <complexType name="ErrorParameterType">
  3149. <sequence>
  3150. <element name="Value" type="xs:string">
  3151. <annotation>
  3152. <documentation>
  3153. Value of the application-specific error parameter.
  3154. </documentation>
  3155. </annotation>
  3156. </element>
  3157. </sequence>
  3158. <attribute name="ParamID" type="xs:string">
  3159. <annotation>
  3160. <documentation>
  3161. Specifies application-specific error parameter name.
  3162. </documentation>
  3163. </annotation>
  3164. </attribute>
  3165. </complexType>
  3166. <complexType name="ErrorType">
  3167. <sequence>
  3168. <element name="ShortMessage" type="xs:string"/>
  3169. <element name="LongMessage" type="xs:string" minOccurs="0"/>
  3170. <element name="ErrorCode" type="xs:token">
  3171. <annotation>
  3172. <documentation>
  3173. Error code can be used by a receiving application to debugging a response
  3174. message. These codes will need to be uniquely defined for each application.
  3175. </documentation>
  3176. </annotation>
  3177. </element>
  3178. <element name="SeverityCode" type="ns:SeverityCodeType">
  3179. <annotation>
  3180. <documentation>
  3181. SeverityCode indicates whether the error is an application
  3182. level error or if it is informational error, i.e., warning.
  3183. </documentation>
  3184. </annotation>
  3185. </element>
  3186. <element name="ErrorParameters" type="ns:ErrorParameterType" minOccurs="0" maxOccurs="unbounded">
  3187. <annotation>
  3188. <documentation>
  3189. This optional element may carry additional application-specific error variables
  3190. that indicate specific information about the error condition particularly in the
  3191. cases where there are multiple instances of the ErrorType which require
  3192. additional context.
  3193. </documentation>
  3194. </annotation>
  3195. </element>
  3196. </sequence>
  3197. </complexType>
  3198. <complexType name="FaultDetailsType">
  3199. <sequence>
  3200. <element name="ErrorCode" type="xs:string">
  3201. <annotation>
  3202. <documentation>
  3203. Error code can be used by a receiving application to debugging a SOAP response
  3204. message that contain one or more SOAP Fault detail objects, i.e., fault detail sub-elements.
  3205. These codes will need to be uniquely defined for each fault scenario.
  3206. </documentation>
  3207. </annotation>
  3208. </element>
  3209. <element name="Severity" type="xs:string">
  3210. <annotation>
  3211. <documentation>
  3212. Severity indicates whether the error is a serious fault
  3213. or if it is informational error, i.e., warning.
  3214. </documentation>
  3215. </annotation>
  3216. </element>
  3217. <element name="DetailedMessage" type="xs:string" minOccurs="0"/>
  3218. </sequence>
  3219. </complexType>
  3220. <complexType name="AbstractRequestType" abstract="true">
  3221. <annotation>
  3222. <documentation>
  3223. Base type definition of request payload that can carry any type
  3224. of payload content with optional versioning information and detail level
  3225. requirements.
  3226. </documentation>
  3227. </annotation>
  3228. <sequence>
  3229. <element name="DetailLevel" type="ns:DetailLevelCodeType" minOccurs="0" maxOccurs="unbounded">
  3230. <annotation>
  3231. <documentation>
  3232. This specifies the required detail level that is needed by a client application pertaining to
  3233. a particular data component (e.g., Item, Transaction, etc.). The detail level is specified in
  3234. the DetailLevelCodeType which has all the enumerated values of the detail level for
  3235. each component.
  3236. </documentation>
  3237. </annotation>
  3238. </element>
  3239. <element name="ErrorLanguage" type="xs:string" minOccurs="0">
  3240. <annotation>
  3241. <documentation>
  3242. This should be the standard RFC 3066 language identification tag, e.g., en_US.
  3243. </documentation>
  3244. </annotation>
  3245. </element>
  3246. <element name="Version" type="xs:string">
  3247. <annotation>
  3248. <documentation>
  3249. This refers to the version of the request payload schema.
  3250. </documentation>
  3251. </annotation>
  3252. </element>
  3253. <any namespace="##local" processContents="lax" minOccurs="0"/>
  3254. </sequence>
  3255. </complexType>
  3256. <complexType name="AbstractResponseType" abstract="true">
  3257. <annotation>
  3258. <documentation>
  3259. Base type definition of a response payload that can carry any
  3260. type of payload content with following optional elements:
  3261. - timestamp of response message,
  3262. - application level acknowledgement, and
  3263. - application-level errors and warnings.
  3264. </documentation>
  3265. </annotation>
  3266. <sequence>
  3267. <element name="Timestamp" type="xs:dateTime" minOccurs="0">
  3268. <annotation>
  3269. <documentation>
  3270. This value represents the date and time (GMT) when the response
  3271. was generated by a service provider (as a result of processing
  3272. of a request).
  3273. </documentation>
  3274. </annotation>
  3275. </element>
  3276. <element name="Ack" type="ns:AckCodeType">
  3277. <annotation>
  3278. <documentation>
  3279. Application level acknowledgement code.
  3280. </documentation>
  3281. </annotation>
  3282. </element>
  3283. <element name="CorrelationID" type="xs:string" minOccurs="0">
  3284. <annotation>
  3285. <documentation>
  3286. CorrelationID may be used optionally with an application
  3287. level acknowledgement.
  3288. </documentation>
  3289. </annotation>
  3290. </element>
  3291. <element name="Errors" type="ns:ErrorType" minOccurs="0" maxOccurs="unbounded"/>
  3292. <element name="Version" type="xs:string">
  3293. <annotation>
  3294. <documentation>
  3295. This refers to the version of the response payload schema.
  3296. </documentation>
  3297. </annotation>
  3298. </element>
  3299. <element name="Build" type="xs:string">
  3300. <annotation>
  3301. <documentation>
  3302. This refers to the specific software build that was used in the deployment
  3303. for processing the request and generating the response.
  3304. </documentation>
  3305. </annotation>
  3306. </element>
  3307. <any namespace="##local" processContents="lax" minOccurs="0"/>
  3308. </sequence>
  3309. </complexType>
  3310. <complexType name="PhoneNumberType">
  3311. <sequence>
  3312. <element name="CountryCode" type="xs:string" minOccurs="0">
  3313. <annotation>
  3314. <documentation>
  3315. Country code associated with this phone number.
  3316. </documentation>
  3317. </annotation>
  3318. </element>
  3319. <element name="PhoneNumber" type="xs:string" minOccurs="0">
  3320. <annotation>
  3321. <documentation>
  3322. Phone number associated with this phone.
  3323. </documentation>
  3324. </annotation>
  3325. </element>
  3326. <element name="Extension" type="xs:string" minOccurs="0">
  3327. <annotation>
  3328. <documentation>
  3329. Extension associated with this phone number.
  3330. </documentation>
  3331. </annotation>
  3332. </element>
  3333. </sequence>
  3334. </complexType>
  3335. <complexType name="AddressType">
  3336. <sequence>
  3337. <element name="Name" type="xs:string" minOccurs="0">
  3338. <annotation>
  3339. <documentation>
  3340. Person's name associated with this address.
  3341. <br/>Character length and limitations: 32 single-byte alphanumeric characters
  3342. </documentation>
  3343. </annotation>
  3344. </element>
  3345. <element name="Street1" type="xs:string" minOccurs="0">
  3346. <annotation>
  3347. <documentation>
  3348. First street address.
  3349. <br/>Character length and limitations: 300 single-byte alphanumeric characters
  3350. </documentation>
  3351. </annotation>
  3352. </element>
  3353. <element name="Street2" type="xs:string" minOccurs="0">
  3354. <annotation>
  3355. <documentation>
  3356. Second street address.
  3357. <br/>Character length and limitations: 300 single-byte alphanumeric characters
  3358. </documentation>
  3359. </annotation>
  3360. </element>
  3361. <element name="CityName" type="xs:string" minOccurs="0">
  3362. <annotation>
  3363. <documentation>
  3364. Name of city.
  3365. <br/>Character length and limitations: 120 single-byte alphanumeric characters</documentation>
  3366. </annotation>
  3367. </element>
  3368. <element name="StateOrProvince" type="xs:string" minOccurs="0">
  3369. <annotation>
  3370. <documentation>
  3371. State or province.
  3372. <br/>Character length and limitations: 120 single-byte alphanumeric characters
  3373. <br/>
  3374. <br/>
  3375. For Canada and the USA, StateOrProvince must be the standard 2-character abbreviation of a state or province.
  3376. <br/>
  3377. <br/>
  3378. <b>Canadian Provinces</b>
  3379. <table>
  3380. <tr>
  3381. <td>Alberta</td>
  3382. <td>AB </td>
  3383. </tr>
  3384. <tr>
  3385. <td>British_Columbia</td>
  3386. <td>BC</td>
  3387. </tr>
  3388. <tr>
  3389. <td>Manitoba</td>
  3390. <td>MB</td>
  3391. </tr>
  3392. <tr>
  3393. <td>New_Brunswick</td>
  3394. <td>NB</td>
  3395. </tr>
  3396. <tr>
  3397. <td>Newfoundland</td>
  3398. <td>NF</td>
  3399. </tr>
  3400. <tr>
  3401. <td>Northwest_Territories</td>
  3402. <td>NT</td>
  3403. </tr>
  3404. <tr>
  3405. <td>Nova_Scotia</td>
  3406. <td>NS </td>
  3407. </tr>
  3408. <tr>
  3409. <td>Nunavut</td>
  3410. <td>NU</td>
  3411. </tr>
  3412. <tr>
  3413. <td>Ontario</td>
  3414. <td>ON</td>
  3415. </tr>
  3416. <tr>
  3417. <td>Prince_Edward_Island</td>
  3418. <td>PE</td>
  3419. </tr>
  3420. <tr>
  3421. <td>Quebec</td>
  3422. <td>QC</td>
  3423. </tr>
  3424. <tr>
  3425. <td>Saskatchewan</td>
  3426. <td>SK</td>
  3427. </tr>
  3428. <tr>
  3429. <td>Yukon</td>
  3430. <td>YK</td>
  3431. </tr>
  3432. </table>
  3433. <br/>
  3434. <br/>
  3435. <b>United States</b>
  3436. <table>
  3437. <tr>
  3438. <td>Alabama</td>
  3439. <td/>
  3440. </tr> AL
  3441. <tr>
  3442. <td>Alaska</td>
  3443. <td>AK</td>
  3444. </tr>
  3445. <tr>
  3446. <td>American_Samoa</td>
  3447. <td>AS</td>
  3448. </tr>
  3449. <tr>
  3450. <td>Arizona</td>
  3451. <td>AZ</td>
  3452. </tr>
  3453. <tr>
  3454. <td>Arkansas</td>
  3455. <td>AR</td>
  3456. </tr>
  3457. <tr>
  3458. <td>California</td>
  3459. <td>CA</td>
  3460. </tr>
  3461. <tr>
  3462. <td>Colorado</td>
  3463. <td>CO</td>
  3464. </tr>
  3465. <tr>
  3466. <td>Connecticut</td>
  3467. <td>CT</td>
  3468. </tr>
  3469. <tr>
  3470. <td>Delaware</td>
  3471. <td>DE</td>
  3472. </tr>
  3473. <tr>
  3474. <td>District_Of_Columbia</td>
  3475. <td>DC</td>
  3476. </tr>
  3477. <tr>
  3478. <td>Federated_States_Of_Micronesia</td>
  3479. <td>FM</td>
  3480. </tr>
  3481. <tr>
  3482. <td>Florida</td>
  3483. <td>FL</td>
  3484. </tr>
  3485. <tr>
  3486. <td>Georgia</td>
  3487. <td>GA</td>
  3488. </tr>
  3489. <tr>
  3490. <td>Guam</td>
  3491. <td>GU</td>
  3492. </tr>
  3493. <tr>
  3494. <td>Hawaii</td>
  3495. <td>HI</td>
  3496. </tr>
  3497. <tr>
  3498. <td>Idaho</td>
  3499. <td>ID </td>
  3500. </tr>
  3501. <tr>
  3502. <td>Illinois</td>
  3503. <td>IL</td>
  3504. </tr>
  3505. <tr>
  3506. <td>Indiana</td>
  3507. <td>IN</td>
  3508. </tr>
  3509. <tr>
  3510. <td>Iowa</td>
  3511. <td>IA</td>
  3512. </tr>
  3513. <tr>
  3514. <td>Kansas</td>
  3515. <td>KS</td>
  3516. </tr>
  3517. <tr>
  3518. <td>Kentucky</td>
  3519. <td>KY</td>
  3520. </tr>
  3521. <tr>
  3522. <td>Louisiana</td>
  3523. <td>LA</td>
  3524. </tr>
  3525. <tr>
  3526. <td>Maine</td>
  3527. <td>ME</td>
  3528. </tr>
  3529. <tr>
  3530. <td>Marshall_Islands</td>
  3531. <td>MH</td>
  3532. </tr>
  3533. <tr>
  3534. <td>Maryland</td>
  3535. <td>MD</td>
  3536. </tr>
  3537. <tr>
  3538. <td>Massachusetts</td>
  3539. <td>MA</td>
  3540. </tr>
  3541. <tr>
  3542. <td>Michigan</td>
  3543. <td>MI</td>
  3544. </tr>
  3545. <tr>
  3546. <td>Minnesota</td>
  3547. <td>MN</td>
  3548. </tr>
  3549. <tr>
  3550. <td>Mississippi</td>
  3551. <td>MS</td>
  3552. </tr>
  3553. <tr>
  3554. <td>Missouri</td>
  3555. <td>MO</td>
  3556. </tr>
  3557. <tr>
  3558. <td>Montana</td>
  3559. <td>MT</td>
  3560. </tr>
  3561. <tr>
  3562. <td>Nebraska</td>
  3563. <td>NE</td>
  3564. </tr>
  3565. <tr>
  3566. <td>Nevada</td>
  3567. <td>NV</td>
  3568. </tr>
  3569. <tr>
  3570. <td>New_Hampshire</td>
  3571. <td>NH</td>
  3572. </tr>
  3573. <tr>
  3574. <td>New_Jersey</td>
  3575. <td>NJ</td>
  3576. </tr>
  3577. <tr>
  3578. <td>New_Mexico</td>
  3579. <td>NM</td>
  3580. </tr>
  3581. <tr>
  3582. <td>New_York</td>
  3583. <td>NY</td>
  3584. </tr>
  3585. <tr>
  3586. <td>North_Carolina</td>
  3587. <td>NC</td>
  3588. </tr>
  3589. <tr>
  3590. <td>North_Dakota</td>
  3591. <td>ND</td>
  3592. </tr>
  3593. <tr>
  3594. <td>Northern_Mariana_Islands</td>
  3595. <td>MP</td>
  3596. </tr>
  3597. <tr>
  3598. <td>Ohio</td>
  3599. <td>OH </td>
  3600. </tr>
  3601. <tr>
  3602. <td>Oklahoma</td>
  3603. <td>OK</td>
  3604. </tr>
  3605. <tr>
  3606. <td>Oregon</td>
  3607. <td>OR</td>
  3608. </tr>
  3609. <tr>
  3610. <td>Palau</td>
  3611. <td>PW</td>
  3612. </tr>
  3613. <tr>
  3614. <td>Pennsylvania</td>
  3615. <td>PA</td>
  3616. </tr>
  3617. <tr>
  3618. <td>Puerto_Rico</td>
  3619. <td>PR</td>
  3620. </tr>
  3621. <tr>
  3622. <td>Rhode_Island</td>
  3623. <td>RI</td>
  3624. </tr>
  3625. <tr>
  3626. <td>South_Carolina</td>
  3627. <td>SC</td>
  3628. </tr>
  3629. <tr>
  3630. <td>South_Dakota</td>
  3631. <td>SD</td>
  3632. </tr>
  3633. <tr>
  3634. <td>Tennessee</td>
  3635. <td>TN </td>
  3636. </tr>
  3637. <tr>
  3638. <td>Texas</td>
  3639. <td>TX</td>
  3640. </tr>
  3641. <tr>
  3642. <td>Utah</td>
  3643. <td>UT</td>
  3644. </tr>
  3645. <tr>
  3646. <td>Vermont</td>
  3647. <td>VT</td>
  3648. </tr>
  3649. <tr>
  3650. <td>Virgin_Islands</td>
  3651. <td>VI</td>
  3652. </tr>
  3653. <tr>
  3654. <td>Virginia</td>
  3655. <td>VA</td>
  3656. </tr>
  3657. <tr>
  3658. <td>Washington</td>
  3659. <td>WA</td>
  3660. </tr>
  3661. <tr>
  3662. <td>West_Virginia</td>
  3663. <td>WV</td>
  3664. </tr>
  3665. <tr>
  3666. <td>Wisconsin</td>
  3667. <td>WI</td>
  3668. </tr>
  3669. <tr>
  3670. <td>Wyoming</td>
  3671. <td>WY</td>
  3672. </tr>
  3673. <tr>
  3674. <td>Armed_Forces_Americas</td>
  3675. <td>AA</td>
  3676. </tr>
  3677. <tr>
  3678. <td>Armed_Forces</td>
  3679. <td>AE</td>
  3680. </tr>
  3681. <tr>
  3682. <td>Armed_Forces_Pacific</td>
  3683. <td>AP</td>
  3684. </tr>
  3685. </table>
  3686. </documentation>
  3687. </annotation>
  3688. </element>
  3689. <element ref="ns:Country" minOccurs="0">
  3690. <annotation>
  3691. <documentation>
  3692. ISO 3166 standard country code
  3693. <br/>Character limit: Two single-byte characters. </documentation>
  3694. </annotation>
  3695. </element>
  3696. <element ref="ns:CountryName" minOccurs="0">
  3697. <annotation>
  3698. <documentation>
  3699. IMPORTANT: Do not set this element for SetExpressCheckout, DoExpressCheckoutPayment, DoDirectPayment, CreateRecurringPaymentsProfile or UpdateRecurringPaymentsProfile.
  3700. <br/>
  3701. <br/>
  3702. This element should only be used in response elements and typically
  3703. should not be used in creating request messages which specify the
  3704. name of a country using the Country element (which refers to a
  3705. 2-letter country code).
  3706. </documentation>
  3707. </annotation>
  3708. </element>
  3709. <element name="Phone" type="xs:string" minOccurs="0">
  3710. <annotation>
  3711. <documentation>
  3712. Telephone number associated with this address</documentation>
  3713. </annotation>
  3714. </element>
  3715. <element name="PostalCode" type="xs:string" minOccurs="0"/>
  3716. <element name="AddressID" type="xs:string" minOccurs="0">
  3717. <annotation>
  3718. <documentation>
  3719. IMPORTANT: Do not set this element for SetExpressCheckout, DoExpressCheckoutPayment, DoDirectPayment, CreateRecurringPaymentsProfile, or UpdateRecurringPaymentsProfile.
  3720. </documentation>
  3721. </annotation>
  3722. </element>
  3723. <element name="AddressOwner" type="ns:AddressOwnerCodeType" minOccurs="0">
  3724. <annotation>
  3725. <documentation>
  3726. IMPORTANT: Do not set this element for SetExpressCheckout, DoExpressCheckoutPayment, DoDirectPayment, CreateRecurringPaymentsProfile or UpdateRecurringPaymentsProfile.
  3727. </documentation>
  3728. </annotation>
  3729. </element>
  3730. <element name="ExternalAddressID" type="xs:string" minOccurs="0">
  3731. <annotation>
  3732. <documentation>
  3733. IMPORTANT: Do not set this element for SetExpressCheckout, DoExpressCheckoutPayment, DoDirectPayment, CreateRecurringPaymentsProfile or UpdateRecurringPaymentsProfile.
  3734. </documentation>
  3735. </annotation>
  3736. </element>
  3737. <element name="InternationalName" type="xs:string" minOccurs="0">
  3738. <annotation>
  3739. <documentation>
  3740. IMPORTANT: Do not set this element for SetExpressCheckout, DoExpressCheckoutPayment, DoDirectPayment, CreateRecurringPaymentsProfile or UpdateRecurringPaymentsProfile.
  3741. <br/>
  3742. <br/>
  3743. Only applicable to SellerPaymentAddress today. Seller's international name that is associated with the payment address.
  3744. </documentation>
  3745. </annotation>
  3746. </element>
  3747. <element name="InternationalStateAndCity" type="xs:string" minOccurs="0">
  3748. <annotation>
  3749. <documentation>
  3750. IMPORTANT: Do not set this element for SetExpressCheckout, DoExpressCheckoutPayment, DoDirectPayment, CreateRecurringPaymentsProfile or UpdateRecurringPaymentsProfile.
  3751. <br/>
  3752. <br/>
  3753. Only applicable to SellerPaymentAddress today. International state and city for the seller's payment address.
  3754. </documentation>
  3755. </annotation>
  3756. </element>
  3757. <element name="InternationalStreet" type="xs:string" minOccurs="0">
  3758. <annotation>
  3759. <documentation>
  3760. IMPORTANT: Do not set this element for SetExpressCheckout, DoExpressCheckoutPayment, DoDirectPayment, CreateRecurringPaymentsProfile or UpdateRecurringPaymentsProfile.
  3761. <br/>
  3762. <br/>
  3763. Only applicable to SellerPaymentAddress today. Seller's international street address that is associated with the payment address.
  3764. </documentation>
  3765. </annotation>
  3766. </element>
  3767. <element name="AddressStatus" type="ns:AddressStatusCodeType" minOccurs="0">
  3768. <annotation>
  3769. <documentation>
  3770. Status of the address on file with PayPal.
  3771. <br/>
  3772. <br/> IMPORTANT: Do not set this element for SetExpressCheckout, DoExpressCheckoutPayment, DoDirectPayment, CreateRecurringPaymentsProfile or UpdateRecurringPaymentsProfile.
  3773. <br/>
  3774. <br/>
  3775. </documentation>
  3776. </annotation>
  3777. </element>
  3778. </sequence>
  3779. </complexType>
  3780. <element name="Country" type="ns:CountryCodeType"/>
  3781. <element name="CountryName" type="xs:string"/>
  3782. <element name="Currency" type="ns:CurrencyCodeType"/>
  3783. <element name="Email" type="xs:string"/>
  3784. <element name="StateOrProvince" type="xs:string"/>
  3785. <element name="UUID" type="cc:UUIDType"/>
  3786. <simpleType name="EscrowCodeType">
  3787. <annotation>
  3788. <documentation>
  3789. EscrowCodeType
  3790. These are the possible codes to describe Escrow options.
  3791. </documentation>
  3792. </annotation>
  3793. <restriction base="xs:token">
  3794. <enumeration value="ByBuyer">
  3795. <annotation>
  3796. <documentation>
  3797. By Buyer
  3798. </documentation>
  3799. </annotation>
  3800. </enumeration>
  3801. <enumeration value="BySeller">
  3802. <annotation>
  3803. <documentation>
  3804. By Seller.
  3805. </documentation>
  3806. </annotation>
  3807. </enumeration>
  3808. <enumeration value="None">
  3809. <annotation>
  3810. <documentation>
  3811. None.
  3812. </documentation>
  3813. </annotation>
  3814. </enumeration>
  3815. <enumeration value="CustomCode">
  3816. <annotation>
  3817. <documentation>
  3818. Reserved for internal or future use.
  3819. </documentation>
  3820. </annotation>
  3821. </enumeration>
  3822. </restriction>
  3823. </simpleType>
  3824. <simpleType name="FeedbackRatingStarCodeType">
  3825. <annotation>
  3826. <documentation>
  3827. FeedbackRatingStarCodeType
  3828. </documentation>
  3829. </annotation>
  3830. <restriction base="xs:token">
  3831. <enumeration value="None">
  3832. <annotation>
  3833. <documentation>
  3834. No graphic displayed
  3835. </documentation>
  3836. </annotation>
  3837. </enumeration>
  3838. <enumeration value="Yellow">
  3839. <annotation>
  3840. <documentation>
  3841. Yellow Star
  3842. </documentation>
  3843. </annotation>
  3844. </enumeration>
  3845. <enumeration value="Turquoise">
  3846. <annotation>
  3847. <documentation>
  3848. Turquoise Star
  3849. </documentation>
  3850. </annotation>
  3851. </enumeration>
  3852. <enumeration value="Purple">
  3853. <annotation>
  3854. <documentation>
  3855. Purple Star
  3856. </documentation>
  3857. </annotation>
  3858. </enumeration>
  3859. <enumeration value="Red">
  3860. <annotation>
  3861. <documentation>
  3862. Red Star
  3863. </documentation>
  3864. </annotation>
  3865. </enumeration>
  3866. <enumeration value="Green">
  3867. <annotation>
  3868. <documentation>
  3869. Green Star
  3870. </documentation>
  3871. </annotation>
  3872. </enumeration>
  3873. <enumeration value="YellowShooting">
  3874. <annotation>
  3875. <documentation>
  3876. Yellow Shooting Star
  3877. </documentation>
  3878. </annotation>
  3879. </enumeration>
  3880. <enumeration value="TurquoiseShooting">
  3881. <annotation>
  3882. <documentation>
  3883. Turquoise Shooting Star
  3884. </documentation>
  3885. </annotation>
  3886. </enumeration>
  3887. <enumeration value="PurpleShooting">
  3888. <annotation>
  3889. <documentation>
  3890. Purple Shooting Star
  3891. </documentation>
  3892. </annotation>
  3893. </enumeration>
  3894. <enumeration value="RedShooting">
  3895. <annotation>
  3896. <documentation>
  3897. Red Shooting Star
  3898. </documentation>
  3899. </annotation>
  3900. </enumeration>
  3901. <enumeration value="Blue">
  3902. <annotation>
  3903. <documentation>
  3904. Blue Star
  3905. </documentation>
  3906. </annotation>
  3907. </enumeration>
  3908. <enumeration value="CustomCode">
  3909. <annotation>
  3910. <documentation>
  3911. Reserved for internal or future use.
  3912. </documentation>
  3913. </annotation>
  3914. </enumeration>
  3915. </restriction>
  3916. </simpleType>
  3917. <simpleType name="GalleryTypeCodeType">
  3918. <annotation>
  3919. <documentation>
  3920. GalleryTypeCodeType
  3921. Specifies the codes for various properties of an item.
  3922. </documentation>
  3923. </annotation>
  3924. <restriction base="xs:token">
  3925. <enumeration value="Featured">
  3926. <annotation>
  3927. <documentation>
  3928. Indicates whether it is a featured item.
  3929. </documentation>
  3930. </annotation>
  3931. </enumeration>
  3932. <enumeration value="Gallery">
  3933. <annotation>
  3934. <documentation>
  3935. Include in the gallery.
  3936. </documentation>
  3937. </annotation>
  3938. </enumeration>
  3939. <enumeration value="CustomCode">
  3940. <annotation>
  3941. <documentation>
  3942. Reserved for internal or future use.
  3943. </documentation>
  3944. </annotation>
  3945. </enumeration>
  3946. </restriction>
  3947. </simpleType>
  3948. <simpleType name="GeneralPaymentMethodCodeType">
  3949. <annotation>
  3950. <documentation>
  3951. GeneralPaymentMethodCodeType - Type declaration to be used
  3952. by other schema. This code identifies the general types of payment means,
  3953. e.g., used by payment service provider applications.
  3954. </documentation>
  3955. </annotation>
  3956. <restriction base="xs:token">
  3957. <enumeration value="Other">
  3958. <annotation>
  3959. <documentation>Custom Code</documentation>
  3960. </annotation>
  3961. </enumeration>
  3962. <enumeration value="Echeck">
  3963. <annotation>
  3964. <documentation>Electronic check.</documentation>
  3965. </annotation>
  3966. </enumeration>
  3967. <enumeration value="ACH">
  3968. <annotation>
  3969. <documentation> ACH.</documentation>
  3970. </annotation>
  3971. </enumeration>
  3972. <enumeration value="Creditcard">
  3973. <annotation>
  3974. <documentation>
  3975. Credit-card.
  3976. </documentation>
  3977. </annotation>
  3978. </enumeration>
  3979. <enumeration value="PayPalBalance">
  3980. <annotation>
  3981. <documentation>
  3982. Pay balance.
  3983. </documentation>
  3984. </annotation>
  3985. </enumeration>
  3986. <enumeration value="CustomCode">
  3987. <annotation>
  3988. <documentation>
  3989. Reserved for internal or future use.
  3990. </documentation>
  3991. </annotation>
  3992. </enumeration>
  3993. </restriction>
  3994. </simpleType>
  3995. <simpleType name="GiftServicesCodeType">
  3996. <annotation>
  3997. <documentation>
  3998. GiftServicesCodeType - Type declaration to be used by other schema's.
  3999. Specifies the codes for the various Gift Services offered by sellers. If
  4000. any of the Gift Services are offered by the seller, the generic gift icon
  4001. should be used to display the item:
  4002. http://pics.ebay.com/aw/pics/gift/gift.gif
  4003. </documentation>
  4004. </annotation>
  4005. <restriction base="xs:token">
  4006. <enumeration value="GiftExpressShipping">
  4007. <annotation>
  4008. <documentation>
  4009. indicates that the seller is offering to ship the item via
  4010. an express shipping method as described in the item
  4011. description.
  4012. </documentation>
  4013. </annotation>
  4014. </enumeration>
  4015. <enumeration value="GiftShipToRecipient">
  4016. <annotation>
  4017. <documentation>
  4018. indicates that the seller is offering to ship to the gift recipient,
  4019. not the buyer, when payment clears.
  4020. </documentation>
  4021. </annotation>
  4022. </enumeration>
  4023. <enumeration value="GiftWrap">
  4024. <annotation>
  4025. <documentation>
  4026. indicates that the seller is offering to wrap the item (and
  4027. optionally include a card) as described in the item
  4028. description.
  4029. </documentation>
  4030. </annotation>
  4031. </enumeration>
  4032. <enumeration value="CustomCode">
  4033. <annotation>
  4034. <documentation>
  4035. Reserved for internal or future use.
  4036. </documentation>
  4037. </annotation>
  4038. </enumeration>
  4039. </restriction>
  4040. </simpleType>
  4041. <simpleType name="HitCounterCodeType">
  4042. <annotation>
  4043. <documentation>
  4044. HitCounterCodeType
  4045. This code identifies the HitCounter codes used to specify whether
  4046. a hit counter is used for the item's listing page and, if so, what type.
  4047. </documentation>
  4048. </annotation>
  4049. <restriction base="xs:token">
  4050. <enumeration value="NoHitCounter">
  4051. <annotation>
  4052. <documentation>No hit counter</documentation>
  4053. </annotation>
  4054. </enumeration>
  4055. <enumeration value="HonestyStyle">
  4056. <annotation>
  4057. <documentation>
  4058. Honesty Style Hit Counter
  4059. </documentation>
  4060. </annotation>
  4061. </enumeration>
  4062. <enumeration value="GreenLED">
  4063. <annotation>
  4064. <documentation>
  4065. Green LED counter. </documentation>
  4066. </annotation>
  4067. </enumeration>
  4068. <enumeration value="Hidden">
  4069. <annotation>
  4070. <documentation>
  4071. Hidden counter.
  4072. </documentation>
  4073. </annotation>
  4074. </enumeration>
  4075. <enumeration value="CustomCode">
  4076. <annotation>
  4077. <documentation>
  4078. Reserved for internal or future use.
  4079. </documentation>
  4080. </annotation>
  4081. </enumeration>
  4082. </restriction>
  4083. </simpleType>
  4084. <simpleType name="InsuranceOptionCodeType">
  4085. <annotation>
  4086. <documentation>
  4087. InsuranceOptionCodeType
  4088. These are the possible codes to describe insurance option as part of shipping
  4089. service.
  4090. </documentation>
  4091. </annotation>
  4092. <restriction base="xs:token">
  4093. <enumeration value="Optional">
  4094. <annotation>
  4095. <documentation>
  4096. Insurance optional.
  4097. </documentation>
  4098. </annotation>
  4099. </enumeration>
  4100. <enumeration value="Required">
  4101. <annotation>
  4102. <documentation>
  4103. Insurance required.
  4104. </documentation>
  4105. </annotation>
  4106. </enumeration>
  4107. <enumeration value="NotOffered">
  4108. <annotation>
  4109. <documentation>
  4110. Insurance not offered.
  4111. </documentation>
  4112. </annotation>
  4113. </enumeration>
  4114. <enumeration value="IncludedInShippingHandling">
  4115. <annotation>
  4116. <documentation>
  4117. Insurance included in Shipping and Handling costs.
  4118. </documentation>
  4119. </annotation>
  4120. </enumeration>
  4121. <enumeration value="CustomCode">
  4122. <annotation>
  4123. <documentation>
  4124. Reserved for internal or future use.
  4125. </documentation>
  4126. </annotation>
  4127. </enumeration>
  4128. </restriction>
  4129. </simpleType>
  4130. <simpleType name="ListingDurationCodeType">
  4131. <annotation>
  4132. <documentation>
  4133. ListingDurationCodeType
  4134. These are the possible codes to describe the number of days the
  4135. auction will be active. Must be one of the values 3, 5, 7, or 10
  4136. for auction and basic Fixed-Price (Type 9) listings. Must be 30,
  4137. 60, 90, 120, or GTC for Stores Fixed-Price (Type 7) listings.
  4138. Specify GTC for the Good 'Til Cancel feature (eBay Stores
  4139. items only).
  4140. </documentation>
  4141. </annotation>
  4142. <restriction base="xs:token">
  4143. <enumeration value="Days_1">
  4144. <annotation>
  4145. <documentation>
  4146. 1 Day
  4147. </documentation>
  4148. </annotation>
  4149. </enumeration>
  4150. <enumeration value="Days_3">
  4151. <annotation>
  4152. <documentation>
  4153. 3 Days
  4154. </documentation>
  4155. </annotation>
  4156. </enumeration>
  4157. <enumeration value="Days_5">
  4158. <annotation>
  4159. <documentation>
  4160. 5 Days
  4161. </documentation>
  4162. </annotation>
  4163. </enumeration>
  4164. <enumeration value="Days_7">
  4165. <annotation>
  4166. <documentation>
  4167. 7 Days
  4168. </documentation>
  4169. </annotation>
  4170. </enumeration>
  4171. <enumeration value="Days_10">
  4172. <annotation>
  4173. <documentation>
  4174. 10 Days
  4175. </documentation>
  4176. </annotation>
  4177. </enumeration>
  4178. <enumeration value="Days_30">
  4179. <annotation>
  4180. <documentation>
  4181. 30 Days
  4182. </documentation>
  4183. </annotation>
  4184. </enumeration>
  4185. <enumeration value="Days_60">
  4186. <annotation>
  4187. <documentation>
  4188. 60 Days
  4189. </documentation>
  4190. </annotation>
  4191. </enumeration>
  4192. <enumeration value="Days_90">
  4193. <annotation>
  4194. <documentation>
  4195. 90 Days
  4196. </documentation>
  4197. </annotation>
  4198. </enumeration>
  4199. <enumeration value="Days_120">
  4200. <annotation>
  4201. <documentation>
  4202. 120 Days
  4203. </documentation>
  4204. </annotation>
  4205. </enumeration>
  4206. <enumeration value="GTC">
  4207. <annotation>
  4208. <documentation>
  4209. GTC
  4210. </documentation>
  4211. </annotation>
  4212. </enumeration>
  4213. <enumeration value="CustomCode">
  4214. <annotation>
  4215. <documentation>
  4216. Reserved for internal or future use.
  4217. </documentation>
  4218. </annotation>
  4219. </enumeration>
  4220. </restriction>
  4221. </simpleType>
  4222. <simpleType name="ListingEnhancementsCodeType">
  4223. <annotation>
  4224. <documentation>
  4225. ListingEnhancementsCodeType
  4226. Specifies the codes for various properties of an item.
  4227. </documentation>
  4228. </annotation>
  4229. <restriction base="xs:token">
  4230. <enumeration value="Border">
  4231. <annotation>
  4232. <documentation>
  4233. Indicates whether an item will be displayed with a border
  4234. that will go around the item (e.g., for category-based search
  4235. result page or store search that brings up multiple items)
  4236. to differentiate it from the rest of list.
  4237. </documentation>
  4238. </annotation>
  4239. </enumeration>
  4240. <enumeration value="BoldTitle">
  4241. <annotation>
  4242. <documentation>
  4243. Indicates whether the bolding option was used.
  4244. </documentation>
  4245. </annotation>
  4246. </enumeration>
  4247. <enumeration value="Featured">
  4248. <annotation>
  4249. <documentation>
  4250. Indicates whether it is a featured item.
  4251. </documentation>
  4252. </annotation>
  4253. </enumeration>
  4254. <enumeration value="Highlight">
  4255. <annotation>
  4256. <documentation>
  4257. Indicates item's listing is highlighted.
  4258. </documentation>
  4259. </annotation>
  4260. </enumeration>
  4261. <enumeration value="HomePageFeatured">
  4262. <annotation>
  4263. <documentation>
  4264. Indicates item's listing is home page featured.
  4265. </documentation>
  4266. </annotation>
  4267. </enumeration>
  4268. <enumeration value="CustomCode">
  4269. <annotation>
  4270. <documentation>
  4271. Reserved for internal or future use.
  4272. </documentation>
  4273. </annotation>
  4274. </enumeration>
  4275. </restriction>
  4276. </simpleType>
  4277. <annotation>
  4278. <documentation>eBay Listing Enhancements Codes</documentation>
  4279. </annotation>
  4280. <annotation>
  4281. <documentation>Code List Agency - eBay, Inc.</documentation>
  4282. </annotation>
  4283. <annotation>
  4284. <documentation>Code List Version - 1.0</documentation>
  4285. </annotation>
  4286. <simpleType name="ListingTypeCodeType">
  4287. <annotation>
  4288. <documentation>
  4289. ListingTypeCodeType - Type declaration to be used
  4290. by other schema. This includes codes indicating the
  4291. type of auction for the listed item.
  4292. </documentation>
  4293. </annotation>
  4294. <restriction base="xs:token">
  4295. <enumeration value="Unknown">
  4296. <annotation>
  4297. <documentation>
  4298. Unknown Listing Type
  4299. </documentation>
  4300. </annotation>
  4301. </enumeration>
  4302. <enumeration value="Chinese">
  4303. <annotation>
  4304. <documentation>
  4305. Chinese auction
  4306. </documentation>
  4307. </annotation>
  4308. </enumeration>
  4309. <enumeration value="Dutch">
  4310. <annotation>
  4311. <documentation>
  4312. Dutch auction
  4313. </documentation>
  4314. </annotation>
  4315. </enumeration>
  4316. <enumeration value="Live">
  4317. <annotation>
  4318. <documentation>
  4319. Live Auctions-type auction
  4320. </documentation>
  4321. </annotation>
  4322. </enumeration>
  4323. <enumeration value="AdType">
  4324. <annotation>
  4325. <documentation>
  4326. Ad type auction
  4327. </documentation>
  4328. </annotation>
  4329. </enumeration>
  4330. <enumeration value="StoresFixedPrice">
  4331. <annotation>
  4332. <documentation>
  4333. Stores Fixed-price auction (US only)
  4334. </documentation>
  4335. </annotation>
  4336. </enumeration>
  4337. <enumeration value="PersonalOffer">
  4338. <annotation>
  4339. <documentation>
  4340. Personal Offer auction
  4341. </documentation>
  4342. </annotation>
  4343. </enumeration>
  4344. <enumeration value="FixedPriceItem">
  4345. <annotation>
  4346. <documentation>
  4347. Fixed Price item ("BIN only").
  4348. </documentation>
  4349. </annotation>
  4350. </enumeration>
  4351. <enumeration value="CustomCode">
  4352. <annotation>
  4353. <documentation>
  4354. Reserved for internal or future use.
  4355. </documentation>
  4356. </annotation>
  4357. </enumeration>
  4358. </restriction>
  4359. </simpleType>
  4360. <simpleType name="MerchandizingPrefCodeType">
  4361. <annotation>
  4362. <documentation>
  4363. MerchandizingPrefCodeType
  4364. </documentation>
  4365. </annotation>
  4366. <restriction base="xs:token">
  4367. <enumeration value="OptIn">
  4368. <annotation>
  4369. <documentation>
  4370. OptIn
  4371. </documentation>
  4372. </annotation>
  4373. </enumeration>
  4374. <enumeration value="OptOut">
  4375. <annotation>
  4376. <documentation>
  4377. OptOut
  4378. </documentation>
  4379. </annotation>
  4380. </enumeration>
  4381. <enumeration value="CustomCode">
  4382. <annotation>
  4383. <documentation>
  4384. Reserved for internal or future use.
  4385. </documentation>
  4386. </annotation>
  4387. </enumeration>
  4388. </restriction>
  4389. </simpleType>
  4390. <simpleType name="ModifyCodeType">
  4391. <annotation>
  4392. <documentation>
  4393. ModifyCodeType
  4394. This code identifies the types of modification you can make on an object.
  4395. account.
  4396. </documentation>
  4397. </annotation>
  4398. <restriction base="xs:token">
  4399. <enumeration value="Dropped">
  4400. <annotation>
  4401. <documentation>Indicate filed is to be dropped.</documentation>
  4402. </annotation>
  4403. </enumeration>
  4404. <enumeration value="Modify">
  4405. <annotation>
  4406. <documentation>Indicate filed is to be modified.</documentation>
  4407. </annotation>
  4408. </enumeration>
  4409. <enumeration value="CustomCode">
  4410. <annotation>
  4411. <documentation>
  4412. Reserved for internal or future use.
  4413. </documentation>
  4414. </annotation>
  4415. </enumeration>
  4416. </restriction>
  4417. </simpleType>
  4418. <simpleType name="PhotoDisplayCodeType">
  4419. <annotation>
  4420. <documentation>
  4421. PhotoDisplayCodeType
  4422. These are types of display for photos used for PhotoHosting slide show.
  4423. </documentation>
  4424. </annotation>
  4425. <restriction base="xs:token">
  4426. <enumeration value="None">
  4427. <annotation>
  4428. <documentation>
  4429. No special Picture Services features.
  4430. </documentation>
  4431. </annotation>
  4432. </enumeration>
  4433. <enumeration value="SlideShow">
  4434. <annotation>
  4435. <documentation>
  4436. Slideshow of multiple pictures.
  4437. </documentation>
  4438. </annotation>
  4439. </enumeration>
  4440. <enumeration value="SuperSize">
  4441. <annotation>
  4442. <documentation>
  4443. Super-size format picture.
  4444. </documentation>
  4445. </annotation>
  4446. </enumeration>
  4447. <enumeration value="PicturePack">
  4448. <annotation>
  4449. <documentation>
  4450. Picture Pack.
  4451. </documentation>
  4452. </annotation>
  4453. </enumeration>
  4454. <enumeration value="CustomCode">
  4455. <annotation>
  4456. <documentation>
  4457. Reserved for internal or future use.
  4458. </documentation>
  4459. </annotation>
  4460. </enumeration>
  4461. </restriction>
  4462. </simpleType>
  4463. <simpleType name="PromotionItemPriceTypeCodeType">
  4464. <annotation>
  4465. <documentation>
  4466. Cross Promotion Method.
  4467. </documentation>
  4468. </annotation>
  4469. <restriction base="xs:token">
  4470. <enumeration value="AuctionPrice">
  4471. <annotation>
  4472. <documentation>
  4473. Auction Item
  4474. </documentation>
  4475. </annotation>
  4476. </enumeration>
  4477. <enumeration value="BuyItNowPrice">
  4478. <annotation>
  4479. <documentation>
  4480. Buy It Now
  4481. </documentation>
  4482. </annotation>
  4483. </enumeration>
  4484. <enumeration value="CustomCode">
  4485. <annotation>
  4486. <documentation>
  4487. Reserved. Do not use.
  4488. </documentation>
  4489. </annotation>
  4490. </enumeration>
  4491. </restriction>
  4492. </simpleType>
  4493. <simpleType name="PromotionItemSelectionCodeType">
  4494. <annotation>
  4495. <documentation>
  4496. Cross Promotion Method.
  4497. </documentation>
  4498. </annotation>
  4499. <restriction base="xs:token">
  4500. <enumeration value="Manual">
  4501. <annotation>
  4502. <documentation>
  4503. Manual Selection
  4504. </documentation>
  4505. </annotation>
  4506. </enumeration>
  4507. <enumeration value="Automatic">
  4508. <annotation>
  4509. <documentation>
  4510. Automatic Selection
  4511. </documentation>
  4512. </annotation>
  4513. </enumeration>
  4514. <enumeration value="CustomCode">
  4515. <annotation>
  4516. <documentation>
  4517. Reserved. Do not use.
  4518. </documentation>
  4519. </annotation>
  4520. </enumeration>
  4521. </restriction>
  4522. </simpleType>
  4523. <simpleType name="PromotionMethodCodeType">
  4524. <annotation>
  4525. <documentation>
  4526. Cross Promotion Method.
  4527. </documentation>
  4528. </annotation>
  4529. <restriction base="xs:token">
  4530. <enumeration value="CrossSell">
  4531. <annotation>
  4532. <documentation>
  4533. Cross Sell
  4534. </documentation>
  4535. </annotation>
  4536. </enumeration>
  4537. <enumeration value="UpSell">
  4538. <annotation>
  4539. <documentation>
  4540. Up Sell
  4541. </documentation>
  4542. </annotation>
  4543. </enumeration>
  4544. <enumeration value="CustomCode">
  4545. <annotation>
  4546. <documentation>
  4547. Reserved. Do not use.
  4548. </documentation>
  4549. </annotation>
  4550. </enumeration>
  4551. </restriction>
  4552. </simpleType>
  4553. <simpleType name="PromotionSchemeCodeType">
  4554. <annotation>
  4555. <documentation>
  4556. Cross Promotion Context Promotion Scheme.
  4557. </documentation>
  4558. </annotation>
  4559. <restriction base="xs:token">
  4560. <enumeration value="ItemToItem">
  4561. <annotation>
  4562. <documentation>
  4563. Item to Item Promotional Scheme
  4564. </documentation>
  4565. </annotation>
  4566. </enumeration>
  4567. <enumeration value="ItemToStoreCat">
  4568. <annotation>
  4569. <documentation>
  4570. Item to Item Store Scheme
  4571. </documentation>
  4572. </annotation>
  4573. </enumeration>
  4574. <enumeration value="StoreToStoreCat">
  4575. <annotation>
  4576. <documentation>
  4577. Store to Store Scheme
  4578. </documentation>
  4579. </annotation>
  4580. </enumeration>
  4581. <enumeration value="CustomCode">
  4582. <annotation>
  4583. <documentation>
  4584. Reserved. Do not use.
  4585. </documentation>
  4586. </annotation>
  4587. </enumeration>
  4588. </restriction>
  4589. </simpleType>
  4590. <simpleType name="PurchasePurposeTypeCodeType">
  4591. <annotation>
  4592. <documentation>
  4593. PurchasePurposeTypeCodeType - Type declaration to be used by other
  4594. schema. This code identifies the purpose of purchases, e.g.,
  4595. by a PayPal application.
  4596. </documentation>
  4597. </annotation>
  4598. <restriction base="xs:token">
  4599. <enumeration value="Other">
  4600. <annotation>
  4601. <documentation>Custom Code</documentation>
  4602. </annotation>
  4603. </enumeration>
  4604. <enumeration value="BuyNowItem">
  4605. <annotation>
  4606. <documentation/>
  4607. </annotation>
  4608. </enumeration>
  4609. <enumeration value="ShoppingCart">
  4610. <annotation>
  4611. <documentation/>
  4612. </annotation>
  4613. </enumeration>
  4614. <enumeration value="AuctionItem">
  4615. <annotation>
  4616. <documentation/>
  4617. </annotation>
  4618. </enumeration>
  4619. <enumeration value="GiftCertificates">
  4620. <annotation>
  4621. <documentation/>
  4622. </annotation>
  4623. </enumeration>
  4624. <enumeration value="Subscription">
  4625. <annotation>
  4626. <documentation/>
  4627. </annotation>
  4628. </enumeration>
  4629. <enumeration value="Donation">
  4630. <annotation>
  4631. <documentation/>
  4632. </annotation>
  4633. </enumeration>
  4634. <enumeration value="eBayBilling">
  4635. <annotation>
  4636. <documentation/>
  4637. </annotation>
  4638. </enumeration>
  4639. <enumeration value="CustomCode">
  4640. <annotation>
  4641. <documentation>
  4642. Reserved for internal or future use.
  4643. </documentation>
  4644. </annotation>
  4645. </enumeration>
  4646. </restriction>
  4647. </simpleType>
  4648. <simpleType name="SellerLevelCodeType">
  4649. <annotation>
  4650. <documentation>
  4651. SellerLevelCodeType
  4652. </documentation>
  4653. </annotation>
  4654. <restriction base="xs:token">
  4655. <enumeration value="Bronze">
  4656. <annotation>
  4657. <documentation>
  4658. Bronze
  4659. </documentation>
  4660. </annotation>
  4661. </enumeration>
  4662. <enumeration value="Silver">
  4663. <annotation>
  4664. <documentation>
  4665. Silver
  4666. </documentation>
  4667. </annotation>
  4668. </enumeration>
  4669. <enumeration value="Gold">
  4670. <annotation>
  4671. <documentation>
  4672. Gold
  4673. </documentation>
  4674. </annotation>
  4675. </enumeration>
  4676. <enumeration value="Platinum">
  4677. <annotation>
  4678. <documentation>
  4679. Platinum
  4680. </documentation>
  4681. </annotation>
  4682. </enumeration>
  4683. <enumeration value="Titanium">
  4684. <annotation>
  4685. <documentation>
  4686. Titanium
  4687. </documentation>
  4688. </annotation>
  4689. </enumeration>
  4690. <enumeration value="None">
  4691. <annotation>
  4692. <documentation>
  4693. None
  4694. </documentation>
  4695. </annotation>
  4696. </enumeration>
  4697. <enumeration value="CustomCode">
  4698. <annotation>
  4699. <documentation>
  4700. Reserved for internal or future use.
  4701. </documentation>
  4702. </annotation>
  4703. </enumeration>
  4704. </restriction>
  4705. </simpleType>
  4706. <simpleType name="SellerPaymentMethodCodeType">
  4707. <annotation>
  4708. <documentation>
  4709. SellerPaymentMethodCodeType
  4710. These are payment methods that sellers can use to pay eBay.
  4711. </documentation>
  4712. </annotation>
  4713. <restriction base="xs:token">
  4714. <enumeration value="Other">
  4715. <annotation>
  4716. <documentation>
  4717. No payment method specified - some other payment method.
  4718. </documentation>
  4719. </annotation>
  4720. </enumeration>
  4721. <enumeration value="Amex">
  4722. <annotation>
  4723. <documentation>
  4724. Amex
  4725. </documentation>
  4726. </annotation>
  4727. </enumeration>
  4728. <enumeration value="Visa">
  4729. <annotation>
  4730. <documentation>
  4731. Visa
  4732. </documentation>
  4733. </annotation>
  4734. </enumeration>
  4735. <enumeration value="Mastercard">
  4736. <annotation>
  4737. <documentation>
  4738. Mastercard
  4739. </documentation>
  4740. </annotation>
  4741. </enumeration>
  4742. <enumeration value="Discover">
  4743. <annotation>
  4744. <documentation>
  4745. Discover
  4746. </documentation>
  4747. </annotation>
  4748. </enumeration>
  4749. <enumeration value="JCB">
  4750. <annotation>
  4751. <documentation>
  4752. JCB
  4753. </documentation>
  4754. </annotation>
  4755. </enumeration>
  4756. <enumeration value="Diners">
  4757. <annotation>
  4758. <documentation>
  4759. Diners
  4760. </documentation>
  4761. </annotation>
  4762. </enumeration>
  4763. <enumeration value="CustomCode">
  4764. <annotation>
  4765. <documentation>
  4766. Reserved for internal or future use.
  4767. </documentation>
  4768. </annotation>
  4769. </enumeration>
  4770. </restriction>
  4771. </simpleType>
  4772. <simpleType name="SeverityCodeType">
  4773. <annotation>
  4774. <documentation>
  4775. SeverityCodeType
  4776. This code identifies the Severity code types in terms of whether
  4777. there is an API-level error or warning that needs to be communicated
  4778. to the client.
  4779. </documentation>
  4780. </annotation>
  4781. <restriction base="xs:token">
  4782. <enumeration value="Warning">
  4783. <annotation>
  4784. <documentation>
  4785. Warning or informational error.
  4786. </documentation>
  4787. </annotation>
  4788. </enumeration>
  4789. <enumeration value="Error">
  4790. <annotation>
  4791. <documentation>
  4792. Application-level error.
  4793. </documentation>
  4794. </annotation>
  4795. </enumeration>
  4796. <enumeration value="PartialSuccess">
  4797. <annotation>
  4798. <documentation>
  4799. Partial Success.
  4800. </documentation>
  4801. </annotation>
  4802. </enumeration>
  4803. <enumeration value="CustomCode">
  4804. <annotation>
  4805. <documentation>
  4806. Reserved for internal or future use.
  4807. </documentation>
  4808. </annotation>
  4809. </enumeration>
  4810. </restriction>
  4811. </simpleType>
  4812. <simpleType name="ShippingOptionCodeType">
  4813. <annotation>
  4814. <documentation>
  4815. ShippingOptionCodeType
  4816. These are the possible codes to describe shipping options in terms
  4817. of where the seller is willing to ship the item.
  4818. </documentation>
  4819. </annotation>
  4820. <restriction base="xs:token">
  4821. <enumeration value="SiteOnly">
  4822. <annotation>
  4823. <documentation>
  4824. Site only.
  4825. </documentation>
  4826. </annotation>
  4827. </enumeration>
  4828. <enumeration value="WorldWide">
  4829. <annotation>
  4830. <documentation>
  4831. WorldWide.
  4832. </documentation>
  4833. </annotation>
  4834. </enumeration>
  4835. <enumeration value="SitePlusRegions">
  4836. <annotation>
  4837. <documentation>
  4838. SitePlusRegions.
  4839. </documentation>
  4840. </annotation>
  4841. </enumeration>
  4842. <enumeration value="WillNotShip">
  4843. <annotation>
  4844. <documentation>
  4845. WillNotShip.
  4846. </documentation>
  4847. </annotation>
  4848. </enumeration>
  4849. <enumeration value="CustomCode">
  4850. <annotation>
  4851. <documentation>
  4852. Reserved for internal or future use.
  4853. </documentation>
  4854. </annotation>
  4855. </enumeration>
  4856. </restriction>
  4857. </simpleType>
  4858. <simpleType name="ShippingPackageCodeType">
  4859. <annotation>
  4860. <documentation>
  4861. ShippingPackageCodeType
  4862. These are the possible codes to describe shipping package options.
  4863. </documentation>
  4864. </annotation>
  4865. <restriction base="xs:token">
  4866. <enumeration value="None">
  4867. <annotation>
  4868. <documentation>
  4869. None.
  4870. </documentation>
  4871. </annotation>
  4872. </enumeration>
  4873. <enumeration value="Letter">
  4874. <annotation>
  4875. <documentation>
  4876. Letter.
  4877. </documentation>
  4878. </annotation>
  4879. </enumeration>
  4880. <enumeration value="LargeEnvelope">
  4881. <annotation>
  4882. <documentation>
  4883. LargeEnvelope
  4884. </documentation>
  4885. </annotation>
  4886. </enumeration>
  4887. <enumeration value="USPSLargePack">
  4888. <annotation>
  4889. <documentation>
  4890. USPS Large Package/Oversize 1
  4891. </documentation>
  4892. </annotation>
  4893. </enumeration>
  4894. <enumeration value="VeryLargePack">
  4895. <annotation>
  4896. <documentation>
  4897. Very Large Package/Oversize 2
  4898. </documentation>
  4899. </annotation>
  4900. </enumeration>
  4901. <enumeration value="UPSLetter">
  4902. <annotation>
  4903. <documentation>
  4904. UPS Letter
  4905. </documentation>
  4906. </annotation>
  4907. </enumeration>
  4908. <enumeration value="USPSFlatRateEnvelope">
  4909. <annotation>
  4910. <documentation>
  4911. USPS Flat Rate Envelope
  4912. </documentation>
  4913. </annotation>
  4914. </enumeration>
  4915. <enumeration value="PackageThickEnvelope">
  4916. <annotation>
  4917. <documentation>
  4918. Package/thick envelope
  4919. </documentation>
  4920. </annotation>
  4921. </enumeration>
  4922. <enumeration value="CustomCode">
  4923. <annotation>
  4924. <documentation>
  4925. Reserved for internal or future use.
  4926. </documentation>
  4927. </annotation>
  4928. </enumeration>
  4929. </restriction>
  4930. </simpleType>
  4931. <simpleType name="ShippingRatesTypeCodeType">
  4932. <annotation>
  4933. <documentation>
  4934. ShippingRatesTypeCodeType - Type declaration to be used
  4935. by other schema. The includes the codes for shipping types
  4936. supported by sellers to transport items sold to buyers.
  4937. </documentation>
  4938. </annotation>
  4939. <restriction base="xs:token">
  4940. <enumeration value="Flat">
  4941. <annotation>
  4942. <documentation>
  4943. Flat shipping rate.
  4944. </documentation>
  4945. </annotation>
  4946. </enumeration>
  4947. <enumeration value="Calculated">
  4948. <annotation>
  4949. <documentation>
  4950. Calculated shipping rate.
  4951. </documentation>
  4952. </annotation>
  4953. </enumeration>
  4954. <enumeration value="CustomCode">
  4955. <annotation>
  4956. <documentation>
  4957. Reserved for internal or future use.
  4958. </documentation>
  4959. </annotation>
  4960. </enumeration>
  4961. </restriction>
  4962. </simpleType>
  4963. <simpleType name="ShippingRegionCodeType">
  4964. <annotation>
  4965. <documentation>
  4966. ShippingRegion CodeType
  4967. This code list module defines the enumerated types of regions for
  4968. shipping items (i.e., a seller may support shipment of an item).
  4969. </documentation>
  4970. </annotation>
  4971. <restriction base="xs:token">
  4972. <enumeration value="Africa">
  4973. <annotation>
  4974. <documentation>
  4975. Africa
  4976. </documentation>
  4977. </annotation>
  4978. </enumeration>
  4979. <enumeration value="Asia">
  4980. <annotation>
  4981. <documentation>
  4982. Asia
  4983. </documentation>
  4984. </annotation>
  4985. </enumeration>
  4986. <enumeration value="Caribbean">
  4987. <annotation>
  4988. <documentation>
  4989. Carribbean
  4990. </documentation>
  4991. </annotation>
  4992. </enumeration>
  4993. <enumeration value="Europe">
  4994. <annotation>
  4995. <documentation>
  4996. Europe
  4997. </documentation>
  4998. </annotation>
  4999. </enumeration>
  5000. <enumeration value="LatinAmerica">
  5001. <annotation>
  5002. <documentation>
  5003. LatinAmerica
  5004. </documentation>
  5005. </annotation>
  5006. </enumeration>
  5007. <enumeration value="MiddleEast">
  5008. <annotation>
  5009. <documentation>
  5010. MiddleEast
  5011. </documentation>
  5012. </annotation>
  5013. </enumeration>
  5014. <enumeration value="NorthAmerica">
  5015. <annotation>
  5016. <documentation>
  5017. NorthAmerica
  5018. </documentation>
  5019. </annotation>
  5020. </enumeration>
  5021. <enumeration value="Oceania">
  5022. <annotation>
  5023. <documentation>
  5024. Oceania (i.e., Pacific region other than Asia)
  5025. </documentation>
  5026. </annotation>
  5027. </enumeration>
  5028. <enumeration value="SouthAmerica">
  5029. <annotation>
  5030. <documentation>
  5031. SouthAmerica
  5032. </documentation>
  5033. </annotation>
  5034. </enumeration>
  5035. <enumeration value="CustomCode">
  5036. <annotation>
  5037. <documentation>
  5038. Reserved for internal or future use.
  5039. </documentation>
  5040. </annotation>
  5041. </enumeration>
  5042. </restriction>
  5043. </simpleType>
  5044. <simpleType name="ShippingServiceCodeType">
  5045. <annotation>
  5046. <documentation>
  5047. ShippingServiceCodeType
  5048. These are the possible codes to describe insurance option as part of shipping
  5049. service.
  5050. </documentation>
  5051. </annotation>
  5052. <restriction base="xs:token">
  5053. <enumeration value="UPSGround">
  5054. <annotation>
  5055. <documentation>
  5056. UPS Ground
  5057. </documentation>
  5058. </annotation>
  5059. </enumeration>
  5060. <enumeration value="UPS3rdDay">
  5061. <annotation>
  5062. <documentation>
  5063. UPS 3rd Day
  5064. </documentation>
  5065. </annotation>
  5066. </enumeration>
  5067. <enumeration value="UPS2ndDay">
  5068. <annotation>
  5069. <documentation>
  5070. UPS 2nd Day
  5071. </documentation>
  5072. </annotation>
  5073. </enumeration>
  5074. <enumeration value="UPSNextDay">
  5075. <annotation>
  5076. <documentation>
  5077. UPS Next Day.
  5078. </documentation>
  5079. </annotation>
  5080. </enumeration>
  5081. <enumeration value="USPSPriority">
  5082. <annotation>
  5083. <documentation>
  5084. USPS Priority.
  5085. </documentation>
  5086. </annotation>
  5087. </enumeration>
  5088. <enumeration value="USPSParcel">
  5089. <annotation>
  5090. <documentation>
  5091. USPS Parcel.
  5092. </documentation>
  5093. </annotation>
  5094. </enumeration>
  5095. <enumeration value="USPSMedia">
  5096. <annotation>
  5097. <documentation>
  5098. USPS Media.
  5099. </documentation>
  5100. </annotation>
  5101. </enumeration>
  5102. <enumeration value="USPSFirstClass">
  5103. <annotation>
  5104. <documentation>
  5105. USPS First Class
  5106. </documentation>
  5107. </annotation>
  5108. </enumeration>
  5109. <enumeration value="ShippingMethodStandard">
  5110. <annotation>
  5111. <documentation>
  5112. ShippingMethodStandard - used by merchant tool only
  5113. </documentation>
  5114. </annotation>
  5115. </enumeration>
  5116. <enumeration value="ShippingMethodExpress">
  5117. <annotation>
  5118. <documentation>
  5119. ShippingMethodExpress- used by merchant tool only
  5120. </documentation>
  5121. </annotation>
  5122. </enumeration>
  5123. <enumeration value="ShippingMethodNextDay">
  5124. <annotation>
  5125. <documentation>
  5126. ShippingMethodNextDay- used by merchant tool only
  5127. </documentation>
  5128. </annotation>
  5129. </enumeration>
  5130. <enumeration value="USPSExpressMail">
  5131. <annotation>
  5132. <documentation>
  5133. USPS Express Mail
  5134. </documentation>
  5135. </annotation>
  5136. </enumeration>
  5137. <enumeration value="USPSGround">
  5138. <annotation>
  5139. <documentation>
  5140. USPS Ground
  5141. </documentation>
  5142. </annotation>
  5143. </enumeration>
  5144. <enumeration value="Download">
  5145. <annotation><documentation> Download. </documentation> </annotation>
  5146. </enumeration>
  5147. <enumeration value="WillCall_Or_Pickup">
  5148. <annotation><documentation> Will Call Or Pick Up. </documentation> </annotation>
  5149. </enumeration>
  5150. <enumeration value="CustomCode">
  5151. <annotation>
  5152. <documentation>
  5153. Reserved for internal or future use.
  5154. </documentation>
  5155. </annotation>
  5156. </enumeration>
  5157. </restriction>
  5158. </simpleType>
  5159. <simpleType name="ShippingTermsCodeType">
  5160. <annotation>
  5161. <documentation>
  5162. ShippingTermsCodeType - Type declaration to be used by other schema's.
  5163. Shipping terms code describes who pays for the shipping of an item.
  5164. These are the standard shipping terms, i.e., terms of delivery of an item.
  5165. </documentation>
  5166. </annotation>
  5167. <restriction base="xs:token">
  5168. <enumeration value="SellerPays">
  5169. <annotation>
  5170. <documentation>
  5171. Seller pays all shipping costs.
  5172. </documentation>
  5173. </annotation>
  5174. </enumeration>
  5175. <enumeration value="BuyerPays">
  5176. <annotation>
  5177. <documentation>
  5178. Buyer pays all shipping costs.
  5179. </documentation>
  5180. </annotation>
  5181. </enumeration>
  5182. <enumeration value="CustomCode">
  5183. <annotation>
  5184. <documentation>
  5185. Reserved for internal or future use.
  5186. </documentation>
  5187. </annotation>
  5188. </enumeration>
  5189. </restriction>
  5190. </simpleType>
  5191. <simpleType name="SiteCodeType">
  5192. <annotation>
  5193. <documentation>
  5194. SiteCodeType
  5195. These are site codes that buyers and sellers can use to identify
  5196. their sites.
  5197. </documentation>
  5198. </annotation>
  5199. <restriction base="xs:token">
  5200. <enumeration value="US">
  5201. <annotation>
  5202. <documentation>
  5203. USA
  5204. </documentation>
  5205. </annotation>
  5206. </enumeration>
  5207. <enumeration value="Canada">
  5208. <annotation>
  5209. <documentation>
  5210. Canada
  5211. </documentation>
  5212. </annotation>
  5213. </enumeration>
  5214. <enumeration value="UK">
  5215. <annotation>
  5216. <documentation>
  5217. United Kingdom
  5218. </documentation>
  5219. </annotation>
  5220. </enumeration>
  5221. <enumeration value="Australia">
  5222. <annotation>
  5223. <documentation>
  5224. Australia
  5225. </documentation>
  5226. </annotation>
  5227. </enumeration>
  5228. <enumeration value="Austria">
  5229. <annotation>
  5230. <documentation>
  5231. Austria
  5232. </documentation>
  5233. </annotation>
  5234. </enumeration>
  5235. <enumeration value="Belgium_French">
  5236. <annotation>
  5237. <documentation>
  5238. Belgium (French)
  5239. </documentation>
  5240. </annotation>
  5241. </enumeration>
  5242. <enumeration value="France">
  5243. <annotation>
  5244. <documentation>
  5245. France
  5246. </documentation>
  5247. </annotation>
  5248. </enumeration>
  5249. <enumeration value="Germany">
  5250. <annotation>
  5251. <documentation>
  5252. Germany
  5253. </documentation>
  5254. </annotation>
  5255. </enumeration>
  5256. <enumeration value="Italy">
  5257. <annotation>
  5258. <documentation>
  5259. Italy
  5260. </documentation>
  5261. </annotation>
  5262. </enumeration>
  5263. <enumeration value="Belgium_Dutch">
  5264. <annotation>
  5265. <documentation>
  5266. Belgium (Dutch)
  5267. </documentation>
  5268. </annotation>
  5269. </enumeration>
  5270. <enumeration value="Netherlands">
  5271. <annotation>
  5272. <documentation>
  5273. Netherlands
  5274. </documentation>
  5275. </annotation>
  5276. </enumeration>
  5277. <enumeration value="Spain">
  5278. <annotation>
  5279. <documentation>
  5280. Spain
  5281. </documentation>
  5282. </annotation>
  5283. </enumeration>
  5284. <enumeration value="Switzerland">
  5285. <annotation>
  5286. <documentation>
  5287. Switzerland
  5288. </documentation>
  5289. </annotation>
  5290. </enumeration>
  5291. <enumeration value="Taiwan">
  5292. <annotation>
  5293. <documentation>
  5294. Taiwan
  5295. </documentation>
  5296. </annotation>
  5297. </enumeration>
  5298. <enumeration value="eBayMotors">
  5299. <annotation>
  5300. <documentation>
  5301. eBay Motors
  5302. </documentation>
  5303. </annotation>
  5304. </enumeration>
  5305. <enumeration value="HongKong">
  5306. <annotation>
  5307. <documentation>
  5308. Hong Kong
  5309. </documentation>
  5310. </annotation>
  5311. </enumeration>
  5312. <enumeration value="Singapore">
  5313. <annotation>
  5314. <documentation>
  5315. Singapore
  5316. </documentation>
  5317. </annotation>
  5318. </enumeration>
  5319. <enumeration value="CustomCode">
  5320. <annotation>
  5321. <documentation>
  5322. Reserved for internal or future use.
  5323. </documentation>
  5324. </annotation>
  5325. </enumeration>
  5326. </restriction>
  5327. </simpleType>
  5328. <simpleType name="UnitCodeType">
  5329. <annotation>
  5330. <documentation>
  5331. UnitCodeType
  5332. </documentation>
  5333. </annotation>
  5334. <restriction base="xs:token">
  5335. <enumeration value="kg">
  5336. <annotation>
  5337. <documentation>
  5338. Kilogram.
  5339. </documentation>
  5340. </annotation>
  5341. </enumeration>
  5342. <enumeration value="lbs">
  5343. <annotation>
  5344. <documentation>
  5345. Pounds.
  5346. </documentation>
  5347. </annotation>
  5348. </enumeration>
  5349. <enumeration value="oz">
  5350. <annotation>
  5351. <documentation>
  5352. Ounces
  5353. </documentation>
  5354. </annotation>
  5355. </enumeration>
  5356. <enumeration value="cm">
  5357. <annotation>
  5358. <documentation>
  5359. Centimeter.
  5360. </documentation>
  5361. </annotation>
  5362. </enumeration>
  5363. <enumeration value="inches">
  5364. <annotation>
  5365. <documentation>
  5366. Inches.
  5367. </documentation>
  5368. </annotation>
  5369. </enumeration>
  5370. <enumeration value="ft">
  5371. <annotation>
  5372. <documentation>
  5373. Feet.
  5374. </documentation>
  5375. </annotation>
  5376. </enumeration>
  5377. <enumeration value="CustomCode">
  5378. <annotation>
  5379. <documentation>
  5380. Reserved for internal or future use.
  5381. </documentation>
  5382. </annotation>
  5383. </enumeration>
  5384. </restriction>
  5385. </simpleType>
  5386. <simpleType name="UserStatusCodeType">
  5387. <annotation>
  5388. <documentation>
  5389. UserStatusCodeType
  5390. </documentation>
  5391. </annotation>
  5392. <restriction base="xs:token">
  5393. <enumeration value="Unknown">
  5394. <annotation>
  5395. <documentation>
  5396. User properties have never been set.
  5397. This value should seldom, if ever, be returned
  5398. and typically represents a problem.
  5399. </documentation>
  5400. </annotation>
  5401. </enumeration>
  5402. <enumeration value="Suspended">
  5403. <annotation>
  5404. <documentation>
  5405. User has been suspended from selling and buying,
  5406. such as for violations of eBay terms or agreement.
  5407. </documentation>
  5408. </annotation>
  5409. </enumeration>
  5410. <enumeration value="Confirmed">
  5411. <annotation>
  5412. <documentation>
  5413. User has completed online registration and has
  5414. properly responded to confirmation email. Most
  5415. users should fall in this category.
  5416. </documentation>
  5417. </annotation>
  5418. </enumeration>
  5419. <enumeration value="Unconfirmed">
  5420. <annotation>
  5421. <documentation>
  5422. User has completed online registration, but
  5423. has either not responded to confirmation email
  5424. or has not yet been sent the confirmation email. .
  5425. </documentation>
  5426. </annotation>
  5427. </enumeration>
  5428. <enumeration value="Ghost">
  5429. <annotation>
  5430. <documentation>
  5431. Registered users of AuctionWeb (pre-eBay)
  5432. who never re-registered on eBay.
  5433. </documentation>
  5434. </annotation>
  5435. </enumeration>
  5436. <enumeration value="InMaintenance">
  5437. <annotation>
  5438. <documentation>
  5439. Temporary user record state indicating the
  5440. record is in the process of being changed by
  5441. eBay. Query user information again to get new
  5442. status.
  5443. </documentation>
  5444. </annotation>
  5445. </enumeration>
  5446. <enumeration value="Deleted">
  5447. <annotation>
  5448. <documentation>
  5449. Records for the specified user have been deleted.
  5450. </documentation>
  5451. </annotation>
  5452. </enumeration>
  5453. <enumeration value="CreditCardVerify">
  5454. <annotation>
  5455. <documentation>
  5456. User has completed registration and confirmation,
  5457. but is pending a verification of credit card information.
  5458. </documentation>
  5459. </annotation>
  5460. </enumeration>
  5461. <enumeration value="AccountOnHold">
  5462. <annotation>
  5463. <documentation>
  5464. User's account is on hold, such as for non-payment
  5465. of amounts due eBay. User cannot sell or buy items.
  5466. </documentation>
  5467. </annotation>
  5468. </enumeration>
  5469. <enumeration value="Merged">
  5470. <annotation>
  5471. <documentation>
  5472. User record has been merged with another account
  5473. record for the same user.
  5474. </documentation>
  5475. </annotation>
  5476. </enumeration>
  5477. <enumeration value="RegistrationCodeMailOut">
  5478. <annotation>
  5479. <documentation>
  5480. User has completed online registration and has
  5481. been sent the confirmation email, but has not yet
  5482. responded to the confirmation email.
  5483. </documentation>
  5484. </annotation>
  5485. </enumeration>
  5486. <enumeration value="TermPending">
  5487. <annotation>
  5488. <documentation>
  5489. User has been scheduled for account closure
  5490. (typically when a user has requested to have
  5491. their account closed.) A user in this state should
  5492. not be considered an active user.
  5493. </documentation>
  5494. </annotation>
  5495. </enumeration>
  5496. <enumeration value="UnconfirmedHalfOptIn">
  5497. <annotation>
  5498. <documentation>
  5499. User has completed the registration for
  5500. Half.com and opted to automatically also be
  5501. registered with eBay, but the registration
  5502. confirmation is still pending.
  5503. </documentation>
  5504. </annotation>
  5505. </enumeration>
  5506. <enumeration value="CreditCardVerifyHalfOptIn">
  5507. <annotation>
  5508. <documentation>
  5509. User has completed the registration for
  5510. Half.com and opted to automatically also be
  5511. registered with eBay, but the verification of
  5512. credit card information is still pending.
  5513. </documentation>
  5514. </annotation>
  5515. </enumeration>
  5516. <enumeration value="UnconfirmedPassport">
  5517. <annotation>
  5518. <documentation>
  5519. Passport User. User has completed the registration process, but the registration confirmation is still pending.
  5520. </documentation>
  5521. </annotation>
  5522. </enumeration>
  5523. <enumeration value="CreditCardVerifyPassport">
  5524. <annotation>
  5525. <documentation>
  5526. Passport User Requiring Credit Card Verification. User has completed the registration process with credit card verification, but the registration confirmation is still pending.
  5527. </documentation>
  5528. </annotation>
  5529. </enumeration>
  5530. <enumeration value="UnconfirmedExpress">
  5531. <annotation>
  5532. <documentation>
  5533. 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.
  5534. </documentation>
  5535. </annotation>
  5536. </enumeration>
  5537. <enumeration value="CustomCode">
  5538. <annotation>
  5539. <documentation>
  5540. Reserved for internal or future use.
  5541. </documentation>
  5542. </annotation>
  5543. </enumeration>
  5544. </restriction>
  5545. </simpleType>
  5546. <simpleType name="VATStatusCodeType">
  5547. <annotation>
  5548. <documentation>
  5549. VATStatusCodeType
  5550. </documentation>
  5551. </annotation>
  5552. <restriction base="xs:token">
  5553. <enumeration value="NoVATTax">
  5554. <annotation>
  5555. <documentation>
  5556. No VAT Tax
  5557. </documentation>
  5558. </annotation>
  5559. </enumeration>
  5560. <enumeration value="VATTax">
  5561. <annotation>
  5562. <documentation>
  5563. VAT Tax
  5564. </documentation>
  5565. </annotation>
  5566. </enumeration>
  5567. <enumeration value="VATExempt">
  5568. <annotation>
  5569. <documentation>
  5570. VAT Exempt
  5571. </documentation>
  5572. </annotation>
  5573. </enumeration>
  5574. <enumeration value="CustomCode">
  5575. <annotation>
  5576. <documentation>
  5577. Reserved for internal or future use.
  5578. </documentation>
  5579. </annotation>
  5580. </enumeration>
  5581. </restriction>
  5582. </simpleType>
  5583. <simpleType name="CreditCardTypeType">
  5584. <annotation>
  5585. <documentation>
  5586. Type declaration to be used by other schemas.
  5587. This is the credit card type
  5588. </documentation>
  5589. </annotation>
  5590. <restriction base="xs:token">
  5591. <enumeration value="Visa"/>
  5592. <enumeration value="MasterCard"/>
  5593. <enumeration value="Discover"/>
  5594. <enumeration value="Amex"/>
  5595. <enumeration value="Switch"/>
  5596. <enumeration value="Solo"/>
  5597. <enumeration value="Maestro"/>
  5598. </restriction>
  5599. </simpleType>
  5600. <simpleType name="NameType">
  5601. <restriction base="xs:string">
  5602. <length value="25"/>
  5603. </restriction>
  5604. </simpleType>
  5605. <simpleType name="SalutationType">
  5606. <restriction base="xs:string">
  5607. <length value="20"/>
  5608. </restriction>
  5609. </simpleType>
  5610. <simpleType name="SuffixType">
  5611. <restriction base="xs:string">
  5612. <length value="12"/>
  5613. </restriction>
  5614. </simpleType>
  5615. <complexType name="PersonNameType">
  5616. <sequence>
  5617. <element name="Salutation" type="ns:SalutationType" minOccurs="0"/>
  5618. <element name="FirstName" type="ns:NameType" minOccurs="0"/>
  5619. <element name="MiddleName" type="ns:NameType" minOccurs="0"/>
  5620. <element name="LastName" type="ns:NameType" minOccurs="0"/>
  5621. <element name="Suffix" type="ns:SuffixType" minOccurs="0"/>
  5622. </sequence>
  5623. </complexType>
  5624. <simpleType name="TransactionId">
  5625. <annotation>
  5626. <documentation>
  5627. TransactionId - Type for a PayPal Transaction ID.
  5628. </documentation>
  5629. </annotation>
  5630. <restriction base="xs:string"/>
  5631. </simpleType>
  5632. <simpleType name="AuthorizationId">
  5633. <annotation>
  5634. <documentation>
  5635. AuthorizationId - Type for a PayPal Authorization ID.
  5636. </documentation>
  5637. </annotation>
  5638. <restriction base="xs:string"/>
  5639. </simpleType>
  5640. <!-- new eBL types -->
  5641. <simpleType name="MerchantPullIDType">
  5642. <restriction base="xs:string"/>
  5643. </simpleType>
  5644. <simpleType name="EmailAddressType">
  5645. <restriction base="xs:string"/>
  5646. </simpleType>
  5647. <simpleType name="ExpressCheckoutTokenType">
  5648. <restriction base="xs:string"/>
  5649. </simpleType>
  5650. <simpleType name="AuthFlowTokenType">
  5651. <restriction base="xs:string"/>
  5652. </simpleType>
  5653. <simpleType name="LanguageCodeType">
  5654. <restriction base="xs:string"/>
  5655. </simpleType>
  5656. <!-- For China Postbacks -->
  5657. <simpleType name="PaymentNotificationServiceCodeType">
  5658. <annotation>
  5659. <documentation>
  5660. PaymentNotificationService
  5661. For SetPaymentStatus API, this value should always be eBayCN.
  5662. </documentation>
  5663. </annotation>
  5664. <restriction base="xs:token">
  5665. <enumeration value="eBayCN"/>
  5666. </restriction>
  5667. </simpleType>
  5668. <simpleType name="OrderID">
  5669. <restriction base="xs:string"/>
  5670. </simpleType>
  5671. <simpleType name="BankIDCodeType">
  5672. <annotation>
  5673. <documentation>
  5674. BankID
  5675. The various banks supported for China postbacks.
  5676. </documentation>
  5677. </annotation>
  5678. <restriction base="xs:token">
  5679. <enumeration value="CMB"/>
  5680. <enumeration value="ICBC"/>
  5681. <enumeration value="CCB"/>
  5682. <enumeration value="ChinaPay"/>
  5683. </restriction>
  5684. </simpleType>
  5685. <simpleType name="PaymentStatusIDCodeType">
  5686. <annotation>
  5687. <documentation>
  5688. PaymentStatus
  5689. The payment statuses supported for China postbacks.
  5690. 0 - None
  5691. 1 - Success
  5692. 2 - Pending or Suspicious
  5693. 3 - Failure
  5694. </documentation>
  5695. </annotation>
  5696. <restriction base="xs:integer">
  5697. <minInclusive value="0"/>
  5698. <maxInclusive value="3"/>
  5699. </restriction>
  5700. </simpleType>
  5701. <simpleType name="RefundType">
  5702. <annotation>
  5703. <documentation>
  5704. RefundType - Type declaration to be used by other
  5705. schema. This code identifies the types of refund transactions
  5706. supported.
  5707. </documentation>
  5708. </annotation>
  5709. <restriction base="xs:token">
  5710. <enumeration value="Other">
  5711. <annotation>
  5712. <documentation/>
  5713. </annotation>
  5714. </enumeration>
  5715. <enumeration value="Full">
  5716. <annotation>
  5717. <documentation>Full Refund</documentation>
  5718. </annotation>
  5719. </enumeration>
  5720. <enumeration value="Partial">
  5721. <annotation>
  5722. <documentation>Partial Refund</documentation>
  5723. </annotation>
  5724. </enumeration>
  5725. <enumeration value="ExternalDispute">
  5726. <annotation>
  5727. <documentation>External Dispute</documentation>
  5728. </annotation>
  5729. </enumeration>
  5730. </restriction>
  5731. </simpleType>
  5732. <simpleType name="UnitOfMeasure">
  5733. <annotation>
  5734. <documentation>
  5735. Based on NRF-ARTS Specification for Units of Measure
  5736. </documentation>
  5737. </annotation>
  5738. <restriction base="xs:token">
  5739. <enumeration value="EA">
  5740. <annotation>
  5741. <documentation>Each</documentation>
  5742. </annotation>
  5743. </enumeration>
  5744. <enumeration value="Hours">
  5745. <annotation>
  5746. <documentation>Hours</documentation>
  5747. </annotation>
  5748. </enumeration>
  5749. <enumeration value="Days">
  5750. <annotation>
  5751. <documentation>Days</documentation>
  5752. </annotation>
  5753. </enumeration>
  5754. <enumeration value="Seconds">
  5755. <annotation>
  5756. <documentation>Seconds</documentation>
  5757. </annotation>
  5758. </enumeration>
  5759. <enumeration value="CrateOf12">
  5760. <annotation>
  5761. <documentation>Crate of 12 bottles of beer</documentation>
  5762. </annotation>
  5763. </enumeration>
  5764. <enumeration value="6Pack">
  5765. <annotation>
  5766. <documentation>6Pack</documentation>
  5767. </annotation>
  5768. </enumeration>
  5769. <enumeration value="GLI">
  5770. <annotation>
  5771. <documentation>Gallon (UK)</documentation>
  5772. </annotation>
  5773. </enumeration>
  5774. <enumeration value="GLL">
  5775. <annotation>
  5776. <documentation>Gallon (US)</documentation>
  5777. </annotation>
  5778. </enumeration>
  5779. <enumeration value="LTR">
  5780. <annotation>
  5781. <documentation>Litre</documentation>
  5782. </annotation>
  5783. </enumeration>
  5784. <enumeration value="INH">
  5785. <annotation>
  5786. <documentation>Inch</documentation>
  5787. </annotation>
  5788. </enumeration>
  5789. <enumeration value="FOT">
  5790. <annotation>
  5791. <documentation>Foot</documentation>
  5792. </annotation>
  5793. </enumeration>
  5794. <enumeration value="MMT">
  5795. <annotation>
  5796. <documentation>Millimeter</documentation>
  5797. </annotation>
  5798. </enumeration>
  5799. <enumeration value="CMQ">
  5800. <annotation>
  5801. <documentation>Centimeter</documentation>
  5802. </annotation>
  5803. </enumeration>
  5804. <enumeration value="MTR">
  5805. <annotation>
  5806. <documentation>Meter</documentation>
  5807. </annotation>
  5808. </enumeration>
  5809. <enumeration value="MTK">
  5810. <annotation>
  5811. <documentation>Square Meter</documentation>
  5812. </annotation>
  5813. </enumeration>
  5814. <enumeration value="MTQ">
  5815. <annotation>
  5816. <documentation>Cubic Meter</documentation>
  5817. </annotation>
  5818. </enumeration>
  5819. <enumeration value="GRM">
  5820. <annotation>
  5821. <documentation>Gram</documentation>
  5822. </annotation>
  5823. </enumeration>
  5824. <enumeration value="KGM">
  5825. <annotation>
  5826. <documentation>Kilogram</documentation>
  5827. </annotation>
  5828. </enumeration>
  5829. <enumeration value="KG">
  5830. <annotation>
  5831. <documentation>Kilogram</documentation>
  5832. </annotation>
  5833. </enumeration>
  5834. <enumeration value="LBR">
  5835. <annotation>
  5836. <documentation>Pound</documentation>
  5837. </annotation>
  5838. </enumeration>
  5839. <enumeration value="ANN">
  5840. <annotation>
  5841. <documentation>Annual</documentation>
  5842. </annotation>
  5843. </enumeration>
  5844. <enumeration value="CEL">
  5845. <annotation>
  5846. <documentation>Degree Celcius</documentation>
  5847. </annotation>
  5848. </enumeration>
  5849. <enumeration value="FAH">
  5850. <annotation>
  5851. <documentation>Degree Fahrenheit</documentation>
  5852. </annotation>
  5853. </enumeration>
  5854. <enumeration value="RESERVED">
  5855. <annotation>
  5856. <documentation>RESERVED</documentation>
  5857. </annotation>
  5858. </enumeration>
  5859. </restriction>
  5860. </simpleType>
  5861. <simpleType name="RedeemedOfferType">
  5862. <restriction base="xs:token">
  5863. <enumeration value="MERCHANT_COUPON"/>
  5864. <enumeration value="LOYALTY_CARD"/>
  5865. <enumeration value="MANUFACTURER_COUPON"/>
  5866. <enumeration value="RESERVED"/>
  5867. </restriction>
  5868. </simpleType>
  5869. <simpleType name="APIType">
  5870. <annotation>
  5871. <documentation>Supported API Types for DoCancel operation</documentation>
  5872. </annotation>
  5873. <restriction base="xs:token">
  5874. <enumeration value="CHECKOUT_AUTHORIZATION">
  5875. <annotation>
  5876. <documentation>POS CHECKOUT AUTHORIZATION</documentation>
  5877. </annotation>
  5878. </enumeration>
  5879. <enumeration value="CHECKOUT_SALE">
  5880. <annotation>
  5881. <documentation>POS CHECKOUT SALE</documentation>
  5882. </annotation>
  5883. </enumeration>
  5884. </restriction>
  5885. </simpleType>
  5886. <!-- eBLPaymentsPP in the reusable section -->
  5887. <element name="APIType" type="ns:APIType"/>
  5888. <element name="RefundType" type="ns:RefundType"/>
  5889. <element name="ReceiptID" type="xs:string"/>
  5890. <element name="SubscriptionID" type="xs:string"/>
  5891. <element name="OptionTrackingDetails" type="ns:OptionTrackingDetailsType"/>
  5892. <element name="ItemTrackingDetails" type="ns:ItemTrackingDetailsType"/>
  5893. <element name="ButtonSearchResult" type="ns:ButtonSearchResultType"/>
  5894. <element name="PaymentTransactions" type="ns:PaymentTransactionSearchResultType"/>
  5895. <element name="PaymentTransactionDetails" type="ns:PaymentTransactionType"/>
  5896. <element name="ThreeDSecureDetails" type="ns:ThreeDSecureInfoType"/>
  5897. <element name="MerchantPullPaymentDetails" type="ns:MerchantPullPaymentType"/>
  5898. <element name="BillUserResponseDetails" type="ns:MerchantPullPaymentResponseType"/>
  5899. <element name="BAUpdateResponseDetails" type="ns:BAUpdateResponseDetailsType"/>
  5900. <element name="SetAuthFlowParamRequestDetails" type="ns:SetAuthFlowParamRequestDetailsType"/>
  5901. <element name="GetAuthDetailsResponseDetails" type="ns:GetAuthDetailsResponseDetailsType"/>
  5902. <element name="SetAccessPermissionsRequestDetails" type="ns:SetAccessPermissionsRequestDetailsType"/>
  5903. <element name="GetAccessPermissionDetailsResponseDetails" type="ns:GetAccessPermissionDetailsResponseDetailsType"/>
  5904. <element name="SetExpressCheckoutRequestDetails" type="ns:SetExpressCheckoutRequestDetailsType"/>
  5905. <element name="ExecuteCheckoutOperationsRequestDetails" type="ns:ExecuteCheckoutOperationsRequestDetailsType"/>
  5906. <element name="ExecuteCheckoutOperationsResponseDetails" type="ns:ExecuteCheckoutOperationsResponseDetailsType"/>
  5907. <element name="GetExpressCheckoutDetailsResponseDetails" type="ns:GetExpressCheckoutDetailsResponseDetailsType"/>
  5908. <element name="DoExpressCheckoutPaymentResponseDetails" type="ns:DoExpressCheckoutPaymentResponseDetailsType"/>
  5909. <element name="DoExpressCheckoutPaymentRequestDetails" type="ns:DoExpressCheckoutPaymentRequestDetailsType"/>
  5910. <element name="DoCaptureResponseDetails" type="ns:DoCaptureResponseDetailsType"/>
  5911. <element name="DoDirectPaymentRequestDetails" type="ns:DoDirectPaymentRequestDetailsType"/>
  5912. <element name="CreateMobilePaymentRequestDetails" type="ns:CreateMobilePaymentRequestDetailsType"/>
  5913. <element name="GetMobileStatusRequestDetails" type="ns:GetMobileStatusRequestDetailsType"/>
  5914. <element name="SetCustomerBillingAgreementRequestDetails" type="ns:SetCustomerBillingAgreementRequestDetailsType"/>
  5915. <element name="GetBillingAgreementCustomerDetailsResponseDetails" type="ns:GetBillingAgreementCustomerDetailsResponseDetailsType"/>
  5916. <element name="DoReferenceTransactionRequestDetails" type="ns:DoReferenceTransactionRequestDetailsType"/>
  5917. <element name="DoReferenceTransactionResponseDetails" type="ns:DoReferenceTransactionResponseDetailsType"/>
  5918. <element name="DoNonReferencedCreditRequestDetails" type="ns:DoNonReferencedCreditRequestDetailsType"/>
  5919. <element name="DoNonReferencedCreditResponseDetails" type="ns:DoNonReferencedCreditResponseDetailsType"/>
  5920. <element name="UATPDetails" type="ns:UATPDetailsType"/>
  5921. <element name="CreateRecurringPaymentsProfileResponseDetails" type="ns:CreateRecurringPaymentsProfileResponseDetailsType"/>
  5922. <element name="CreateRecurringPaymentsProfileRequestDetails" type="ns:CreateRecurringPaymentsProfileRequestDetailsType"/>
  5923. <element name="EnhancedData" type="ns:EnhancedDataType"/>
  5924. <element name="AirlineItinerary" type="ns:AirlineItineraryType"/>
  5925. <element name="InstrumentDetails" type="ns:InstrumentDetailsType"/>
  5926. <element name="OfferDetails" type="ns:OfferDetailsType"/>
  5927. <element name="GetRecurringPaymentsProfileDetailsResponseDetails" type="ns:GetRecurringPaymentsProfileDetailsResponseDetailsType"/>
  5928. <element name="ManageRecurringPaymentsProfileStatusRequestDetails" type="ns:ManageRecurringPaymentsProfileStatusRequestDetailsType"/>
  5929. <element name="ManageRecurringPaymentsProfileStatusResponseDetails" type="ns:ManageRecurringPaymentsProfileStatusResponseDetailsType"/>
  5930. <element name="BillOutstandingAmountRequestDetails" type="ns:BillOutstandingAmountRequestDetailsType"/>
  5931. <element name="BillOutstandingAmountResponseDetails" type="ns:BillOutstandingAmountResponseDetailsType"/>
  5932. <element name="UpdateRecurringPaymentsProfileRequestDetails" type="ns:UpdateRecurringPaymentsProfileRequestDetailsType"/>
  5933. <element name="UpdateRecurringPaymentsProfileResponseDetails" type="ns:UpdateRecurringPaymentsProfileResponseDetailsType"/>
  5934. <element name="AuthorizationInfo" type="ns:AuthorizationInfoType"/>
  5935. <element name="GetIncentiveEvaluationRequestDetails" type="ns:GetIncentiveEvaluationRequestDetailsType"/>
  5936. <element name="GetIncentiveEvaluationResponseDetails" type="ns:GetIncentiveEvaluationResponseDetailsType"/>
  5937. <element name="MerchantStoreDetails" type="ns:MerchantStoreDetailsType"/>
  5938. <element name="RefundItemDetails" type="ns:InvoiceItemType"/>
  5939. <simpleType name="IncentiveRequestCodeType">
  5940. <annotation>
  5941. <documentation>
  5942. IncentiveRequestType
  5943. 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.
  5944. </documentation>
  5945. </annotation>
  5946. <restriction base="xs:token">
  5947. <enumeration value="InCheckout"/>
  5948. <enumeration value="PreCheckout"/>
  5949. </restriction>
  5950. </simpleType>
  5951. <simpleType name="IncentiveRequestDetailLevelCodeType">
  5952. <annotation>
  5953. <documentation>
  5954. IncentiveRequestDetailLevelType
  5955. 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.
  5956. </documentation>
  5957. </annotation>
  5958. <restriction base="xs:token">
  5959. <enumeration value="Aggregated"/>
  5960. <enumeration value="Detail"/>
  5961. </restriction>
  5962. </simpleType>
  5963. <simpleType name="IncentiveTypeCodeType">
  5964. <annotation>
  5965. <documentation>
  5966. IncentiveType
  5967. This identifies the type of INCENTIVE for the redemption code.
  5968. </documentation>
  5969. </annotation>
  5970. <restriction base="xs:token">
  5971. <enumeration value="Coupon"/>
  5972. <enumeration value="eBayGiftCertificate"/>
  5973. <enumeration value="eBayGiftCard"/>
  5974. <enumeration value="PayPalRewardVoucher"/>
  5975. <enumeration value="MerchantGiftCertificate"/>
  5976. <enumeration value="eBayRewardVoucher"/>
  5977. </restriction>
  5978. </simpleType>
  5979. <complexType name="IncentiveAppliedToType">
  5980. <sequence>
  5981. <element name="BucketId" type="xs:string" minOccurs="0"/>
  5982. <element name="ItemId" type="xs:string" minOccurs="0"/>
  5983. <element name="IncentiveAmount" type="cc:BasicAmountType" minOccurs="0"/>
  5984. <element name="SubType" type="xs:string" minOccurs="0"/>
  5985. </sequence>
  5986. </complexType>
  5987. <complexType name="IncentiveDetailType">
  5988. <sequence>
  5989. <element name="RedemptionCode" type="xs:string" minOccurs="0"/>
  5990. <element name="DisplayCode" type="xs:string" minOccurs="0"/>
  5991. <element name="ProgramId" type="xs:string" minOccurs="0"/>
  5992. <element name="IncentiveType" type="ns:IncentiveTypeCodeType" minOccurs="0"/>
  5993. <element name="IncentiveDescription" type="xs:string" minOccurs="0"/>
  5994. <element name="AppliedTo" type="ns:IncentiveAppliedToType" minOccurs="0" maxOccurs="unbounded"/>
  5995. <element name="Status" type="xs:string" minOccurs="0"/>
  5996. <element name="ErrorCode" type="xs:string" minOccurs="0"/>
  5997. </sequence>
  5998. </complexType>
  5999. <complexType name="IncentiveItemType">
  6000. <sequence>
  6001. <element name="ItemId" type="xs:string" minOccurs="0"/>
  6002. <element name="PurchaseTime" type="xs:dateTime" minOccurs="0"/>
  6003. <element name="ItemCategoryList" type="xs:string" minOccurs="0"/>
  6004. <element name="ItemPrice" type="cc:BasicAmountType" minOccurs="0"/>
  6005. <element name="ItemQuantity" type="xs:integer" minOccurs="0"/>
  6006. </sequence>
  6007. </complexType>
  6008. <complexType name="IncentiveBucketType">
  6009. <sequence>
  6010. <element name="Items" type="ns:IncentiveItemType" minOccurs="0" maxOccurs="unbounded"/>
  6011. <element name="BucketId" type="xs:string" minOccurs="0"/>
  6012. <element name="SellerId" type="xs:string" minOccurs="0"/>
  6013. <element name="ExternalSellerId" type="xs:string" minOccurs="0"/>
  6014. <element name="BucketSubtotalAmt" type="cc:BasicAmountType" minOccurs="0"/>
  6015. <element name="BucketShippingAmt" type="cc:BasicAmountType" minOccurs="0"/>
  6016. <element name="BucketInsuranceAmt" type="cc:BasicAmountType" minOccurs="0"/>
  6017. <element name="BucketSalesTaxAmt" type="cc:BasicAmountType" minOccurs="0"/>
  6018. <element name="BucketTotalAmt" type="cc:BasicAmountType" minOccurs="0"/>
  6019. </sequence>
  6020. </complexType>
  6021. <complexType name="IncentiveRequestDetailsType">
  6022. <sequence>
  6023. <element name="RequestId" type="xs:string" minOccurs="0"/>
  6024. <element name="RequestType" type="ns:IncentiveRequestCodeType" minOccurs="0"/>
  6025. <element name="RequestDetailLevel" type="ns:IncentiveRequestDetailLevelCodeType" minOccurs="0"/>
  6026. </sequence>
  6027. </complexType>
  6028. <complexType name="GetIncentiveEvaluationRequestDetailsType">
  6029. <sequence>
  6030. <element name="ExternalBuyerId" type="xs:string" minOccurs="0" maxOccurs="1"/>
  6031. <element name="IncentiveCodes" type="xs:string" minOccurs="0" maxOccurs="1000"/>
  6032. <element name="ApplyIndication" type="ns:IncentiveApplyIndicationType" minOccurs="0" maxOccurs="1000"/>
  6033. <element name="Buckets" type="ns:IncentiveBucketType" minOccurs="0" maxOccurs="100"/>
  6034. <element name="CartTotalAmt" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1"/>
  6035. <element name="RequestDetails" type="ns:IncentiveRequestDetailsType" minOccurs="0" maxOccurs="1"/>
  6036. </sequence>
  6037. </complexType>
  6038. <complexType name="GetIncentiveEvaluationResponseDetailsType">
  6039. <sequence>
  6040. <element name="IncentiveDetails" type="ns:IncentiveDetailType" minOccurs="0" maxOccurs="1000"/>
  6041. <element name="RequestId" type="xs:string" minOccurs="0" maxOccurs="1"/>
  6042. </sequence>
  6043. </complexType>
  6044. <complexType name="SetExpressCheckoutRequestDetailsType">
  6045. <sequence>
  6046. <element name="OrderTotal" type="cc:BasicAmountType" minOccurs="0">
  6047. <annotation>
  6048. <documentation>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.
  6049. <br/>
  6050. <br/>
  6051. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.
  6052. <br/>
  6053. <br/>
  6054. 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 (,).
  6055. </documentation>
  6056. </annotation>
  6057. </element>
  6058. <element name="ReturnURL" type="xs:string">
  6059. <annotation>
  6060. <documentation>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.
  6061. <br/>
  6062. <br/>
  6063. <b>Required</b>
  6064. <br/>
  6065. <br/>
  6066. Character length and limitations: no limit. </documentation>
  6067. </annotation>
  6068. </element>
  6069. <element name="CancelURL" type="xs:string">
  6070. <annotation>
  6071. <documentation>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.
  6072. <br/>
  6073. <br/>
  6074. <b>Required</b>
  6075. <br/>
  6076. <br/>
  6077. Character length and limitations: no limit
  6078. </documentation>
  6079. </annotation>
  6080. </element>
  6081. <element name="TrackingImageURL" type="xs:string" minOccurs="0">
  6082. <annotation>
  6083. <documentation>Tracking URL for ebay.
  6084. <br/>
  6085. <br/>
  6086. <b>Required</b>
  6087. <br/>
  6088. <br/>
  6089. Character length and limitations: no limit
  6090. </documentation>
  6091. </annotation>
  6092. </element>
  6093. <element name="giropaySuccessURL" type="xs:string" minOccurs="0">
  6094. <annotation>
  6095. <documentation>URL to which the customer's browser is returned after paying with giropay online.
  6096. <br/>
  6097. <br/>
  6098. Optional
  6099. <br/>
  6100. <br/>Character length and limitations: no limit.
  6101. </documentation>
  6102. </annotation>
  6103. </element>
  6104. <element name="giropayCancelURL" type="xs:string" minOccurs="0">
  6105. <annotation>
  6106. <documentation>URL to which the customer's browser is returned after fail to pay with giropay online.
  6107. <br/>
  6108. <br/>
  6109. Optional
  6110. <br/>
  6111. <br/>Character length and limitations: no limit.
  6112. </documentation>
  6113. </annotation>
  6114. </element>
  6115. <element name="BanktxnPendingURL" type="xs:string" minOccurs="0">
  6116. <annotation>
  6117. <documentation>URL to which the customer's browser can be returned in the mEFT done page.
  6118. <br/>
  6119. <br/>
  6120. Optional
  6121. <br/>
  6122. <br/>Character length and limitations: no limit.
  6123. </documentation>
  6124. </annotation>
  6125. </element>
  6126. <element name="Token" type="ns:ExpressCheckoutTokenType" minOccurs="0">
  6127. <annotation>
  6128. <documentation>On your first invocation of SetExpressCheckoutRequest, the value of this token is returned by SetExpressCheckoutResponse.
  6129. <br/>
  6130. <br/>
  6131. Optional
  6132. <br/>
  6133. <br/>
  6134. 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.
  6135. <br/>
  6136. <br/>
  6137. Character length and limitations: 20 single-byte characters
  6138. </documentation>
  6139. </annotation>
  6140. </element>
  6141. <element name="MaxAmount" type="cc:BasicAmountType" minOccurs="0">
  6142. <annotation>
  6143. <documentation>The expected maximum total amount of the complete order, including shipping cost and tax charges.
  6144. <br/>
  6145. <br/>
  6146. Optional
  6147. <br/>
  6148. <br/>
  6149. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.
  6150. <br/>
  6151. <br/>
  6152. 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 (,).
  6153. </documentation>
  6154. </annotation>
  6155. </element>
  6156. <element name="OrderDescription" type="xs:string" minOccurs="0">
  6157. <annotation>
  6158. <documentation>Description of items the customer is purchasing.
  6159. <br/>
  6160. <br/>
  6161. Optional
  6162. <br/>
  6163. <br/>Character length and limitations: 127 single-byte alphanumeric characters
  6164. </documentation>
  6165. </annotation>
  6166. </element>
  6167. <element name="Custom" type="xs:string" minOccurs="0">
  6168. <annotation>
  6169. <documentation>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.
  6170. <br/>
  6171. <br/>
  6172. Optional
  6173. <br/>
  6174. <br/>Character length and limitations: 256 single-byte alphanumeric characters
  6175. </documentation>
  6176. </annotation>
  6177. </element>
  6178. <element name="InvoiceID" type="xs:string" minOccurs="0">
  6179. <annotation>
  6180. <documentation>Your own unique invoice or tracking number. PayPal returns this value to you on DoExpressCheckoutPaymentResponse.
  6181. <br/>
  6182. <br/>
  6183. Optional
  6184. <br/>
  6185. <br/>Character length and limitations: 127 single-byte alphanumeric characters
  6186. </documentation>
  6187. </annotation>
  6188. </element>
  6189. <element name="ReqConfirmShipping" type="xs:string" minOccurs="0">
  6190. <annotation>
  6191. <documentation>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.
  6192. <br/>
  6193. <br/>
  6194. Optional
  6195. <br/>
  6196. <br/>Character length and limitations: One single-byte numeric character.
  6197. </documentation>
  6198. </annotation>
  6199. </element>
  6200. <element name="ReqBillingAddress" type="xs:string" minOccurs="0">
  6201. <annotation>
  6202. <documentation>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.
  6203. <br/>
  6204. <br/>
  6205. Optional
  6206. <br/>
  6207. <br/>Character length and limitations: One single-byte numeric character.
  6208. </documentation>
  6209. </annotation>
  6210. </element>
  6211. <element name="BillingAddress" type="ns:AddressType" minOccurs="0">
  6212. <annotation>
  6213. <documentation>
  6214. The billing address for the buyer.
  6215. <br/>
  6216. Optional
  6217. <br/>
  6218. <br/>
  6219. If you include the BillingAddress element, the AddressType elements are required:
  6220. <br/>
  6221. <br/>
  6222. Name
  6223. <br/>
  6224. <br/>
  6225. Street1
  6226. <br/>
  6227. <br/>
  6228. CityName
  6229. <br/>
  6230. <br/>
  6231. CountryCode
  6232. <br/>
  6233. <br/>
  6234. <b>Do not set set the CountryName element.</b>
  6235. </documentation>
  6236. </annotation>
  6237. </element>
  6238. <element name="NoShipping" type="xs:string" minOccurs="0">
  6239. <annotation>
  6240. <documentation>The value 1 indicates that on the PayPal pages, no shipping address fields should be displayed whatsoever.
  6241. <br/>
  6242. <br/>
  6243. Optional
  6244. <br/>
  6245. <br/>
  6246. Character length and limitations: Four single-byte numeric characters.
  6247. </documentation>
  6248. </annotation>
  6249. </element>
  6250. <element name="AddressOverride" type="xs:string" minOccurs="0">
  6251. <annotation>
  6252. <documentation>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.
  6253. <br/>
  6254. <br/>
  6255. Optional
  6256. <br/>
  6257. <br/>Character length and limitations: Four single-byte numeric characters.
  6258. </documentation>
  6259. </annotation>
  6260. </element>
  6261. <element name="LocaleCode" type="xs:string" minOccurs="0">
  6262. <annotation>
  6263. <documentation>
  6264. Locale of pages displayed by PayPal during Express Checkout.
  6265. <br/>
  6266. <br/>
  6267. Optional
  6268. <br/>
  6269. <br/>
  6270. Character length and limitations: Five single-byte alphabetic characters, upper- or lowercase.
  6271. <br/>
  6272. <br/>
  6273. Allowable values:
  6274. <br/>
  6275. AU or en_AU
  6276. <br/>
  6277. DE or de_DE
  6278. <br/>
  6279. FR or fr_FR
  6280. <br/>
  6281. GB or en_GB
  6282. <br/>
  6283. IT or it_IT
  6284. <br/>
  6285. JP or ja_JP
  6286. <br/>
  6287. US or en_US
  6288. </documentation>
  6289. </annotation>
  6290. </element>
  6291. <element name="PageStyle" type="xs:string" minOccurs="0">
  6292. <annotation>
  6293. <documentation>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.
  6294. <br/>
  6295. <br/>
  6296. Optional
  6297. <br/>
  6298. <br/>Character length and limitations: 30 single-byte alphabetic characters.
  6299. </documentation>
  6300. </annotation>
  6301. </element>
  6302. <element name="cpp-header-image" type="xs:string" minOccurs="0">
  6303. <annotation>
  6304. <documentation>
  6305. 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.
  6306. <br/>
  6307. <br/>
  6308. Optional
  6309. <br/>
  6310. <br/>
  6311. Character length and limitations: 127
  6312. </documentation>
  6313. </annotation>
  6314. </element>
  6315. <element name="cpp-header-border-color" type="xs:string" minOccurs="0">
  6316. <annotation>
  6317. <documentation>
  6318. 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.
  6319. <br/>
  6320. <br/>
  6321. Optional
  6322. <br/>
  6323. <br/>Character length and limitations: Six character HTML hexadecimal color code in ASCII
  6324. </documentation>
  6325. </annotation>
  6326. </element>
  6327. <element name="cpp-header-back-color" type="xs:string" minOccurs="0">
  6328. <annotation>
  6329. <documentation>
  6330. Sets the background color for the header of the payment page.
  6331. <br/>
  6332. <br/>
  6333. Optional
  6334. <br/>
  6335. <br/>Character length and limitation: Six character HTML hexadecimal color code in ASCII
  6336. </documentation>
  6337. </annotation>
  6338. </element>
  6339. <element name="cpp-payflow-color" type="xs:string" minOccurs="0">
  6340. <annotation>
  6341. <documentation>
  6342. Sets the background color for the payment page.
  6343. <br/>
  6344. <br/>
  6345. Optional
  6346. <br/>
  6347. <br/>Character length and limitation: Six character HTML hexadecimal color code in ASCII
  6348. </documentation>
  6349. </annotation>
  6350. </element>
  6351. <element name="cpp-cart-border-color" type="xs:string" minOccurs="0">
  6352. <annotation>
  6353. <documentation>
  6354. Sets the cart gradient color for the Mini Cart on 1X flow.
  6355. <br/>
  6356. <br/>
  6357. Optional
  6358. <br/>
  6359. <br/>Character length and limitation: Six character HTML hexadecimal color code in ASCII
  6360. </documentation>
  6361. </annotation>
  6362. </element>
  6363. <element name="cpp-logo-image" type="xs:string" minOccurs="0">
  6364. <annotation>
  6365. <documentation>
  6366. 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.
  6367. <br/>
  6368. <br/>
  6369. Optional
  6370. <br/>
  6371. <br/>
  6372. Character length and limitations: 127
  6373. </documentation>
  6374. </annotation>
  6375. </element>
  6376. <element name="Address" type="ns:AddressType" minOccurs="0">
  6377. <annotation>
  6378. <documentation>Customer's shipping address.
  6379. <br/>
  6380. <br/>
  6381. Optional
  6382. <br/>
  6383. <br/>
  6384. If you include a shipping address and set the AddressOverride element on the request, PayPal returns this same address in GetExpressCheckoutDetailsResponse.
  6385. </documentation>
  6386. </annotation>
  6387. </element>
  6388. <element name="PaymentAction" type="ns:PaymentActionCodeType" minOccurs="0">
  6389. <annotation>
  6390. <documentation>
  6391. How you want to obtain payment.
  6392. <br/>
  6393. <br/>
  6394. <b>Required</b>
  6395. <br/>
  6396. <br/>
  6397. Authorization indicates that this payment is a basic authorization subject to settlement with PayPal Authorization and Capture.
  6398. <br/>
  6399. <br/>
  6400. Order indicates that this payment is is an order authorization subject to settlement with PayPal Authorization and Capture.
  6401. <br/>
  6402. <br/>
  6403. Sale indicates that this is a final sale for which you are requesting payment.
  6404. <br/>
  6405. <br/>
  6406. IMPORTANT: You cannot set PaymentAction to Sale or Order on SetExpressCheckoutRequest and then change PaymentAction to Authorization on the final Express Checkout API, DoExpressCheckoutPaymentRequest.
  6407. <br/>
  6408. <br/>
  6409. Character length and limit: Up to 13 single-byte alphabetic characters
  6410. </documentation>
  6411. </annotation>
  6412. </element>
  6413. <element name="SolutionType" type="ns:SolutionTypeType" minOccurs="0">
  6414. <annotation>
  6415. <documentation>
  6416. This will indicate which flow you are choosing (expresschecheckout or expresscheckout optional)
  6417. <br/>
  6418. <br/>
  6419. Optional
  6420. <br/>
  6421. <br/>
  6422. None
  6423. <br/>
  6424. <br/>
  6425. Sole indicates that you are in the ExpressO flow
  6426. <br/>
  6427. <br/>
  6428. Mark indicates that you are in the old express flow.
  6429. <br/>
  6430. <br/>
  6431. </documentation>
  6432. </annotation>
  6433. </element>
  6434. <element name="LandingPage" type="ns:LandingPageType" minOccurs="0">
  6435. <annotation>
  6436. <documentation>
  6437. This indicates Which page to display for ExpressO (Billing or Login)
  6438. <br/>
  6439. <br/>
  6440. Optional
  6441. <br/>
  6442. <br/>
  6443. None
  6444. <br/>
  6445. <br/>
  6446. Billing indicates that you are not a paypal account holder
  6447. <br/>
  6448. <br/>
  6449. Login indicates that you are a paypal account holder
  6450. <br/>
  6451. <br/>
  6452. </documentation>
  6453. </annotation>
  6454. </element>
  6455. <element name="BuyerEmail" type="ns:EmailAddressType" minOccurs="0">
  6456. <annotation>
  6457. <documentation>
  6458. 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.
  6459. <br/>
  6460. <br/>
  6461. Optional
  6462. <br/>
  6463. <br/>Character length and limit: 127 single-byte alphanumeric characters
  6464. </documentation>
  6465. </annotation>
  6466. </element>
  6467. <element name="ChannelType" type="ns:ChannelType" minOccurs="0"/>
  6468. <element name="BillingAgreementDetails" type="ns:BillingAgreementDetailsType" minOccurs="0" maxOccurs="unbounded"/>
  6469. <element name="PromoCodes" type="xs:string" minOccurs="0" maxOccurs="unbounded">
  6470. <annotation>
  6471. <documentation>
  6472. Promo Code<br/>
  6473. <br/>
  6474. Optional<br/>
  6475. <br/>
  6476. List of promo codes supplied by merchant. These promo codes enable the Merchant Services Promotion Financing feature.
  6477. </documentation>
  6478. </annotation>
  6479. </element>
  6480. <element name="PayPalCheckOutBtnType" type="xs:string" minOccurs="0" maxOccurs="1">
  6481. <annotation>
  6482. <documentation>
  6483. Default Funding option for PayLater Checkout button.
  6484. </documentation>
  6485. </annotation>
  6486. </element>
  6487. <element name="ProductCategory" type="ns:ProductCategoryType" minOccurs="0" maxOccurs="1">
  6488. <annotation>
  6489. <documentation>
  6490. </documentation>
  6491. </annotation>
  6492. </element>
  6493. <element name="ShippingMethod" type="ns:ShippingServiceCodeType" minOccurs="0" maxOccurs="1">
  6494. <annotation>
  6495. <documentation>
  6496. </documentation>
  6497. </annotation>
  6498. </element>
  6499. <element name="ProfileAddressChangeDate" type="xs:dateTime" minOccurs="0" maxOccurs="1">
  6500. <annotation>
  6501. <documentation>
  6502. Date and time (in GMT in the format yyyy-MM-ddTHH:mm:ssZ) at which address was changed by the user.
  6503. </documentation>
  6504. </annotation>
  6505. </element>
  6506. <element name="AllowNote" type="xs:string" minOccurs="0" maxOccurs="1">
  6507. <annotation>
  6508. <documentation>
  6509. 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.<br/>
  6510. Optional<br/>
  6511. Character length and limitations: One single-byte numeric character.<br/>
  6512. Allowable values: 0,1
  6513. </documentation>
  6514. </annotation>
  6515. </element>
  6516. <element name="FundingSourceDetails" type="ns:FundingSourceDetailsType" minOccurs="0" maxOccurs="1">
  6517. <annotation>
  6518. <documentation>
  6519. Funding source preferences.
  6520. </documentation>
  6521. </annotation>
  6522. </element>
  6523. <element name="BrandName" type="xs:string" minOccurs="0" maxOccurs="1">
  6524. <annotation>
  6525. <documentation>
  6526. The label that needs to be displayed on the cancel links in the PayPal hosted checkout pages. <br/>
  6527. Optional <br/>
  6528. Character length and limit: 127 single-byte alphanumeric characters
  6529. </documentation>
  6530. </annotation>
  6531. </element>
  6532. <element name="CallbackURL" type="xs:string" minOccurs="0" maxOccurs="1">
  6533. <annotation>
  6534. <documentation>
  6535. URL for PayPal to use to retrieve shipping, handling, insurance, and tax details from your website.<br/>
  6536. Optional<br/>
  6537. Character length and limitations: 2048 characters.<br/>
  6538. </documentation>
  6539. </annotation>
  6540. </element>
  6541. <element name="EnhancedCheckoutData" type="ed:EnhancedCheckoutDataType" minOccurs="0" maxOccurs="1">
  6542. <annotation>
  6543. <documentation>
  6544. Enhanced data for different industry segments.<br/>
  6545. Optional<br/>
  6546. </documentation>
  6547. </annotation>
  6548. </element>
  6549. <element name="OtherPaymentMethods" type="ns:OtherPaymentMethodDetailsType" minOccurs="0" maxOccurs="unbounded" >
  6550. <annotation>
  6551. <documentation>
  6552. List of other payment methods the user can pay with.
  6553. Optional
  6554. Refer to the OtherPaymentMethodDetailsType for more details.
  6555. </documentation>
  6556. </annotation>
  6557. </element>
  6558. <element name="BuyerDetails" type="ns:BuyerDetailsType" minOccurs="0" maxOccurs="1">
  6559. <annotation>
  6560. <documentation>
  6561. Details about the buyer's account.<br/>
  6562. Optional<br/>
  6563. Refer to the BuyerDetailsType for more details. <br/>
  6564. </documentation>
  6565. </annotation>
  6566. </element>
  6567. <element name="PaymentDetails" type="ns:PaymentDetailsType" minOccurs="0" maxOccurs="10">
  6568. <annotation>
  6569. <documentation>
  6570. Information about the payment.
  6571. </documentation>
  6572. </annotation>
  6573. </element>
  6574. <element name="FlatRateShippingOptions" type="ns:ShippingOptionType" minOccurs="0" maxOccurs="unbounded">
  6575. <annotation>
  6576. <documentation>
  6577. List of Fall Back Shipping options provided by merchant.
  6578. </documentation>
  6579. </annotation>
  6580. </element>
  6581. <element name="CallbackTimeout" type="xs:string" minOccurs="0" maxOccurs="1">
  6582. <annotation>
  6583. <documentation>
  6584. Information about the call back timeout override.
  6585. </documentation>
  6586. </annotation>
  6587. </element>
  6588. <element name="CallbackVersion" type="xs:string" minOccurs="0" maxOccurs="1">
  6589. <annotation>
  6590. <documentation>
  6591. Information about the call back version.
  6592. </documentation>
  6593. </annotation>
  6594. </element>
  6595. <element name="CustomerServiceNumber" type="xs:string" minOccurs="0" maxOccurs="1">
  6596. <annotation>
  6597. <documentation>
  6598. Information about the Customer service number.
  6599. </documentation>
  6600. </annotation>
  6601. </element>
  6602. <element name="GiftMessageEnable" type="xs:string" minOccurs="0" maxOccurs="1">
  6603. <annotation>
  6604. <documentation>
  6605. Information about the Gift message enable.
  6606. </documentation>
  6607. </annotation>
  6608. </element>
  6609. <element name="GiftReceiptEnable" type="xs:string" minOccurs="0" maxOccurs="1">
  6610. <annotation>
  6611. <documentation>
  6612. Information about the Gift receipt enable.
  6613. </documentation>
  6614. </annotation>
  6615. </element>
  6616. <element name="GiftWrapEnable" type="xs:string" minOccurs="0" maxOccurs="1">
  6617. <annotation>
  6618. <documentation>
  6619. Information about the Gift Wrap enable.
  6620. </documentation>
  6621. </annotation>
  6622. </element>
  6623. <element name="GiftWrapName" type="xs:string" minOccurs="0" maxOccurs="1">
  6624. <annotation>
  6625. <documentation>
  6626. Information about the Gift Wrap name.
  6627. </documentation>
  6628. </annotation>
  6629. </element>
  6630. <element name="GiftWrapAmount" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  6631. <annotation>
  6632. <documentation>
  6633. Information about the Gift Wrap amount.
  6634. </documentation>
  6635. </annotation>
  6636. </element>
  6637. <element name="BuyerEmailOptInEnable" type="xs:string" minOccurs="0" maxOccurs="1">
  6638. <annotation>
  6639. <documentation>
  6640. Information about the Buyer email option enable .
  6641. </documentation>
  6642. </annotation>
  6643. </element>
  6644. <element name="SurveyEnable" type="xs:string" minOccurs="0" maxOccurs="1">
  6645. <annotation>
  6646. <documentation>
  6647. Information about the survey enable.
  6648. </documentation>
  6649. </annotation>
  6650. </element>
  6651. <element name="SurveyQuestion" type="xs:string" minOccurs="0" maxOccurs="1">
  6652. <annotation>
  6653. <documentation>
  6654. Information about the survey question.
  6655. </documentation>
  6656. </annotation>
  6657. </element>
  6658. <element name="SurveyChoice" type="xs:string" minOccurs="0" maxOccurs="unbounded">
  6659. <annotation>
  6660. <documentation>
  6661. Information about the survey choices for survey question.
  6662. </documentation>
  6663. </annotation>
  6664. </element>
  6665. <element name="TotalType" type="ns:TotalType" minOccurs="0"/>
  6666. <element name="NoteToBuyer" type="xs:string" minOccurs="0" maxOccurs="1">
  6667. <annotation>
  6668. <documentation>
  6669. Any message the seller would like to be displayed in the Mini Cart for UX.
  6670. </documentation>
  6671. </annotation>
  6672. </element>
  6673. <element name="Incentives" type="ns:IncentiveInfoType" minOccurs="0" maxOccurs="unbounded">
  6674. <annotation>
  6675. <documentation>
  6676. Incentive Code<br/>
  6677. <br/>
  6678. Optional<br/>
  6679. <br/>
  6680. List of incentive codes supplied by ebay/merchant.
  6681. </documentation>
  6682. </annotation>
  6683. </element>
  6684. <element name="ReqInstrumentDetails" type="xs:string" minOccurs="0" maxOccurs="1">
  6685. <annotation>
  6686. <documentation>
  6687. Merchant specified flag which indicates whether to return Funding Instrument Details in DoEC or not.
  6688. <br/>
  6689. <br/>
  6690. <b>Optional</b>
  6691. <br/>
  6692. <br/>
  6693. </documentation>
  6694. </annotation>
  6695. </element>
  6696. <element name="ExternalRememberMeOptInDetails" type="ns:ExternalRememberMeOptInDetailsType" minOccurs="0" maxOccurs="1">
  6697. <annotation>
  6698. <documentation>
  6699. This element contains information that allows the merchant to request to
  6700. opt into external remember me on behalf of the buyer or to request login
  6701. bypass using external remember me. Note the opt-in details are silently
  6702. ignored if the ExternalRememberMeID is present.
  6703. </documentation>
  6704. </annotation>
  6705. </element>
  6706. <element name="FlowControlDetails" type="ns:FlowControlDetailsType" minOccurs="0" maxOccurs="1">
  6707. <annotation>
  6708. <documentation>
  6709. An optional set of values related to flow-specific details.
  6710. </documentation>
  6711. </annotation>
  6712. </element>
  6713. <element name="DisplayControlDetails" type="ns:DisplayControlDetailsType" minOccurs="0" maxOccurs="1">
  6714. <annotation>
  6715. <documentation>
  6716. An optional set of values related to display-specific details.
  6717. </documentation>
  6718. </annotation>
  6719. </element>
  6720. <element name="ExternalPartnerTrackingDetails" type="ns:ExternalPartnerTrackingDetailsType" minOccurs="0" maxOccurs="1">
  6721. <annotation>
  6722. <documentation>
  6723. An optional set of values related to tracking for external partner.
  6724. </documentation>
  6725. </annotation>
  6726. </element>
  6727. </sequence>
  6728. </complexType>
  6729. <complexType name="ExecuteCheckoutOperationsRequestDetailsType">
  6730. <sequence>
  6731. <element name="Token" type="ns:ExpressCheckoutTokenType" minOccurs="0">
  6732. <annotation>
  6733. <documentation>
  6734. On your first invocation of ExecuteCheckoutOperationsRequest, the value of this token is returned by ExecuteCheckoutOperationsResponse.
  6735. <br/>
  6736. <br/>
  6737. Optional
  6738. <br/>
  6739. <br/>
  6740. 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.
  6741. <br/>
  6742. <br/>
  6743. Character length and limitations: 20 single-byte characters
  6744. </documentation>
  6745. </annotation>
  6746. </element>
  6747. <element name="SetDataRequest" type="ns:SetDataRequestType" minOccurs="1" maxOccurs="1">
  6748. <annotation>
  6749. <documentation>
  6750. All the Data required to initiate the checkout session is passed in this element.
  6751. </documentation>
  6752. </annotation>
  6753. </element>
  6754. <element name="AuthorizationRequest" type="ns:AuthorizationRequestType" minOccurs="0" maxOccurs="1">
  6755. <annotation>
  6756. <documentation>
  6757. If auto authorization is required, this should be passed in with IsRequested set to yes.
  6758. </documentation>
  6759. </annotation>
  6760. </element>
  6761. </sequence>
  6762. </complexType>
  6763. <complexType name="SetDataRequestType">
  6764. <sequence>
  6765. <element name="BillingApprovalDetails" type="ns:BillingApprovalDetailsType" minOccurs="0" maxOccurs="unbounded">
  6766. <annotation>
  6767. <documentation>
  6768. Details about Billing Agreements requested to be created.
  6769. </documentation>
  6770. </annotation>
  6771. </element>
  6772. <element name="BuyerDetail" type="ns:BuyerDetailType" minOccurs="0" maxOccurs="1">
  6773. <annotation>
  6774. <documentation>
  6775. Only needed if Auto Authorization is requested. The authentication session token will be passed in here.
  6776. </documentation>
  6777. </annotation>
  6778. </element>
  6779. <element name="InfoSharingDirectives" type="ns:InfoSharingDirectivesType" minOccurs="0" maxOccurs="1">
  6780. <annotation>
  6781. <documentation>
  6782. Requests for specific buyer information like Billing Address to be returned through GetExpressCheckoutDetails should be specified under this.
  6783. </documentation>
  6784. </annotation>
  6785. </element>
  6786. </sequence>
  6787. </complexType>
  6788. <complexType name="AuthorizationRequestType">
  6789. <sequence>
  6790. <element name="IsRequested" type="xs:boolean" minOccurs="1" maxOccurs="1">
  6791. <annotation>
  6792. <documentation>
  6793. </documentation>
  6794. </annotation>
  6795. </element>
  6796. </sequence>
  6797. </complexType>
  6798. <complexType name="BillingApprovalDetailsType">
  6799. <sequence>
  6800. <element name="ApprovalType" type="ns:ApprovalTypeType" minOccurs="1">
  6801. <annotation>
  6802. <documentation>The Type of Approval requested - Billing Agreement or Profile</documentation>
  6803. </annotation>
  6804. </element>
  6805. <element name="ApprovalSubType" type="ns:ApprovalSubTypeType" minOccurs="0">
  6806. <annotation>
  6807. <documentation>The Approval subtype - Must be MerchantInitiatedBilling for BillingAgreement ApprovalType</documentation>
  6808. </annotation>
  6809. </element>
  6810. <element name="OrderDetails" type="ns:OrderDetailsType" minOccurs="0">
  6811. <annotation>
  6812. <documentation>Description about the Order</documentation>
  6813. </annotation>
  6814. </element>
  6815. <element name="PaymentDirectives" type="ns:PaymentDirectivesType" minOccurs="0">
  6816. <annotation>
  6817. <documentation>Directives about the type of payment</documentation>
  6818. </annotation>
  6819. </element>
  6820. <element name="Custom" type="xs:string" minOccurs="0">
  6821. <annotation>
  6822. <documentation>Client may pass in its identification of this Billing Agreement. It used for the client's tracking purposes.</documentation>
  6823. </annotation>
  6824. </element>
  6825. </sequence>
  6826. </complexType>
  6827. <complexType name="InfoSharingDirectivesType">
  6828. <sequence>
  6829. <element name="ReqBillingAddress" type="xs:string" minOccurs="0">
  6830. <annotation>
  6831. <documentation>If Billing Address should be returned in GetExpressCheckoutDetails response, this parameter should be set to yes here</documentation>
  6832. </annotation>
  6833. </element>
  6834. </sequence>
  6835. </complexType>
  6836. <complexType name="OrderDetailsType">
  6837. <sequence>
  6838. <element name="Description" type="xs:string" minOccurs="0">
  6839. <annotation>
  6840. <documentation>Description of the Order.</documentation>
  6841. </annotation>
  6842. </element>
  6843. <element name="MaxAmount" type="cc:BasicAmountType" minOccurs="0">
  6844. <annotation>
  6845. <documentation>Expected maximum amount that the merchant may pull using DoReferenceTransaction</documentation>
  6846. </annotation>
  6847. </element>
  6848. </sequence>
  6849. </complexType>
  6850. <complexType name="PaymentDirectivesType">
  6851. <sequence>
  6852. <element name="PaymentType" type="ns:MerchantPullPaymentCodeType" minOccurs="0">
  6853. <annotation>
  6854. <documentation>Type of the Payment is it Instant or Echeck or Any.</documentation>
  6855. </annotation>
  6856. </element>
  6857. </sequence>
  6858. </complexType>
  6859. <complexType name="BuyerDetailType">
  6860. <sequence>
  6861. <element name="IdentificationInfo" type="ns:IdentificationInfoType" minOccurs="0">
  6862. <annotation>
  6863. <documentation>Information that is used to indentify the Buyer. This is used for auto authorization. Mandatory if Authorization is requested.</documentation>
  6864. </annotation>
  6865. </element>
  6866. </sequence>
  6867. </complexType>
  6868. <complexType name="IdentificationInfoType">
  6869. <sequence>
  6870. <element name="MobileIDInfo" type="ns:MobileIDInfoType" minOccurs="0">
  6871. <annotation>
  6872. <documentation>Mobile specific buyer identification.</documentation>
  6873. </annotation>
  6874. </element>
  6875. <element name="RememberMeIDInfo" type="ns:RememberMeIDInfoType" minOccurs="0" maxOccurs="1">
  6876. <annotation>
  6877. <documentation>Contains login bypass information.</documentation>
  6878. </annotation>
  6879. </element>
  6880. </sequence>
  6881. </complexType>
  6882. <complexType name="MobileIDInfoType">
  6883. <sequence>
  6884. <element name="SessionToken" type="xs:string">
  6885. <annotation>
  6886. <documentation>The Session token returned during buyer authentication.</documentation>
  6887. </annotation>
  6888. </element>
  6889. </sequence>
  6890. </complexType>
  6891. <complexType name="RememberMeIDInfoType">
  6892. <sequence>
  6893. <element name="ExternalRememberMeID" type="xs:string" minOccurs="0" maxOccurs="1">
  6894. <annotation>
  6895. <documentation>
  6896. External remember-me ID returned by GetExpressCheckoutDetails on successful opt-in. The
  6897. ExternalRememberMeID is a 17-character alphanumeric (encrypted) string that identifies
  6898. the buyer's remembered login with a merchant and has meaning only to the merchant. If
  6899. present, requests that the web flow attempt bypass of login.
  6900. </documentation>
  6901. </annotation>
  6902. </element>
  6903. </sequence>
  6904. </complexType>
  6905. <complexType name="FundingSourceDetailsType">
  6906. <sequence>
  6907. <element name="AllowPushFunding" type="xs:string" minOccurs="0" maxOccurs="1">
  6908. <annotation>
  6909. <documentation>
  6910. Allowable values: 0,1 <br/>
  6911. The value 1 indicates that the customer can accept push funding, and 0 means they cannot.<br/>
  6912. Optional<br/>
  6913. Character length and limitations: One single-byte numeric character.<br/>
  6914. </documentation>
  6915. </annotation>
  6916. </element>
  6917. <element name="UserSelectedFundingSource" type="ns:UserSelectedFundingSourceType" minOccurs="0" maxOccurs="1">
  6918. <annotation>
  6919. <documentation>
  6920. Allowable values: ELV, CreditCard, ChinaUnionPay, BML <br/>
  6921. This element could be used to specify the perered funding option <br/>
  6922. for a guest users. It has effect only if LandingPage element is set to Billing. <br/>
  6923. Otherwise it will be ignored.
  6924. </documentation>
  6925. </annotation>
  6926. </element>
  6927. </sequence>
  6928. </complexType>
  6929. <complexType name="BillingAgreementDetailsType">
  6930. <sequence>
  6931. <element name="BillingType" type="ns:BillingCodeType" minOccurs="1" maxOccurs="1">
  6932. <annotation>
  6933. <documentation>
  6934. </documentation>
  6935. </annotation>
  6936. </element>
  6937. <element name="BillingAgreementDescription" type="xs:string" minOccurs="0" maxOccurs="1">
  6938. <annotation>
  6939. <documentation>
  6940. Only needed for AutoBill billinng type.
  6941. </documentation>
  6942. </annotation>
  6943. </element>
  6944. <element name="PaymentType" type="ns:MerchantPullPaymentCodeType" minOccurs="0" maxOccurs="1">
  6945. <annotation>
  6946. <documentation>
  6947. </documentation>
  6948. </annotation>
  6949. </element>
  6950. <element name="BillingAgreementCustom" type="xs:string" minOccurs="0" maxOccurs="1">
  6951. <annotation>
  6952. <documentation>
  6953. Custom annotation field for your exclusive use.
  6954. </documentation>
  6955. </annotation>
  6956. </element>
  6957. </sequence>
  6958. </complexType>
  6959. <complexType name="GetExpressCheckoutDetailsResponseDetailsType">
  6960. <sequence>
  6961. <element name="Token" type="ns:ExpressCheckoutTokenType">
  6962. <annotation>
  6963. <documentation>
  6964. The timestamped token value that was returned by SetExpressCheckoutResponse and passed on GetExpressCheckoutDetailsRequest.
  6965. <br/>
  6966. <br/>Character length and limitations: 20 single-byte characters</documentation>
  6967. </annotation>
  6968. </element>
  6969. <element name="PayerInfo" type="ns:PayerInfoType">
  6970. <annotation>
  6971. <documentation>
  6972. Information about the payer</documentation>
  6973. </annotation>
  6974. </element>
  6975. <element name="Custom" type="xs:string" minOccurs="0">
  6976. <annotation>
  6977. <documentation>
  6978. A free-form field for your own use, as set by you in the Custom element of SetExpressCheckoutRequest.
  6979. <br/>
  6980. <br/>Character length and limitations: 256 single-byte alphanumeric characters</documentation>
  6981. </annotation>
  6982. </element>
  6983. <element name="InvoiceID" type="xs:string" minOccurs="0">
  6984. <annotation>
  6985. <documentation>
  6986. Your own invoice or tracking number, as set by you in the InvoiceID element of SetExpressCheckoutRequest.
  6987. <br/>
  6988. <br/>Character length and limitations: 127 single-byte alphanumeric characters
  6989. </documentation>
  6990. </annotation>
  6991. </element>
  6992. <element name="ContactPhone" type="xs:string" minOccurs="0">
  6993. <annotation>
  6994. <documentation>
  6995. Payer's contact telephone number. PayPal returns a contact telephone number only if your Merchant account profile settings require that the buyer enter one.</documentation>
  6996. </annotation>
  6997. </element>
  6998. <element name="BillingAgreementAcceptedStatus" type="xs:boolean" minOccurs="0" maxOccurs="1">
  6999. <annotation>
  7000. <documentation>
  7001. </documentation>
  7002. </annotation>
  7003. </element>
  7004. <element name="RedirectRequired" type="xs:string" minOccurs="0" maxOccurs="1">
  7005. <annotation>
  7006. <documentation>
  7007. </documentation>
  7008. </annotation>
  7009. </element>
  7010. <element name="BillingAddress" type="ns:AddressType" minOccurs="0">
  7011. <annotation>
  7012. <documentation>Customer's billing address.
  7013. <br/>
  7014. <br/>
  7015. Optional
  7016. <br/>
  7017. <br/>
  7018. 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.
  7019. </documentation>
  7020. </annotation>
  7021. </element>
  7022. <element name="Note" type="xs:string" minOccurs="0" maxOccurs="1">
  7023. <annotation>
  7024. <documentation>
  7025. Text note entered by the buyer in PayPal flow.
  7026. </documentation>
  7027. </annotation>
  7028. </element>
  7029. <element name="CheckoutStatus" type="xs:string" minOccurs="0" maxOccurs="1">
  7030. <annotation>
  7031. <documentation>
  7032. Returns the status of the EC checkout session.<br/>
  7033. Values include 'PaymentActionNotInitiated', 'PaymentActionFailed', 'PaymentActionInProgress', 'PaymentCompleted'.<br/>
  7034. </documentation>
  7035. </annotation>
  7036. </element>
  7037. <element name="PayPalAdjustment" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  7038. <annotation>
  7039. <documentation>
  7040. 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.
  7041. </documentation>
  7042. </annotation>
  7043. </element>
  7044. <element name="PaymentDetails" type="ns:PaymentDetailsType" minOccurs="0" maxOccurs="10">
  7045. <annotation>
  7046. <documentation>
  7047. Information about the individual purchased items.
  7048. </documentation>
  7049. </annotation>
  7050. </element>
  7051. <element name="UserSelectedOptions" type="ns:UserSelectedOptionType" minOccurs="0" maxOccurs="1">
  7052. <annotation>
  7053. <documentation>
  7054. Information about the user selected options.
  7055. </documentation>
  7056. </annotation>
  7057. </element>
  7058. <element name="IncentiveDetails" type="ns:IncentiveDetailsType" minOccurs="0" maxOccurs="unbounded">
  7059. <annotation>
  7060. <documentation>
  7061. Information about the incentives that were applied from Ebay RYP page and PayPal RYP page.
  7062. </documentation>
  7063. </annotation>
  7064. </element>
  7065. <element name="GiftMessage" type="xs:string" minOccurs="0" maxOccurs="1">
  7066. <annotation>
  7067. <documentation>
  7068. Information about the Gift message.
  7069. </documentation>
  7070. </annotation>
  7071. </element>
  7072. <element name="GiftReceiptEnable" type="xs:string" minOccurs="0" maxOccurs="1">
  7073. <annotation>
  7074. <documentation>
  7075. Information about the Gift receipt enable.
  7076. </documentation>
  7077. </annotation>
  7078. </element>
  7079. <element name="GiftWrapName" type="xs:string" minOccurs="0" maxOccurs="1">
  7080. <annotation>
  7081. <documentation>
  7082. Information about the Gift Wrap name.
  7083. </documentation>
  7084. </annotation>
  7085. </element>
  7086. <element name="GiftWrapAmount" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  7087. <annotation>
  7088. <documentation>
  7089. Information about the Gift Wrap amount.
  7090. </documentation>
  7091. </annotation>
  7092. </element>
  7093. <element name="BuyerMarketingEmail" type="xs:string" minOccurs="0" maxOccurs="1">
  7094. <annotation>
  7095. <documentation>
  7096. Information about the Buyer marketing email.
  7097. </documentation>
  7098. </annotation>
  7099. </element>
  7100. <element name="SurveyQuestion" type="xs:string" minOccurs="0" maxOccurs="1">
  7101. <annotation>
  7102. <documentation>
  7103. Information about the survey question.
  7104. </documentation>
  7105. </annotation>
  7106. </element>
  7107. <element name="SurveyChoiceSelected" type="xs:string" minOccurs="0" maxOccurs="unbounded">
  7108. <annotation>
  7109. <documentation>
  7110. Information about the survey choice selected by the user.
  7111. </documentation>
  7112. </annotation>
  7113. </element>
  7114. <element name="PaymentRequestInfo" type="ns:PaymentRequestInfoType" minOccurs="0" maxOccurs="10">
  7115. <annotation>
  7116. <documentation>
  7117. Contains payment request information about each bucket in the cart.
  7118. </documentation>
  7119. </annotation>
  7120. </element>
  7121. <element name="ExternalRememberMeStatusDetails" type="ns:ExternalRememberMeStatusDetailsType" minOccurs="0" maxOccurs="1">
  7122. <annotation>
  7123. <documentation>
  7124. Response information resulting from opt-in operation or current login bypass status.
  7125. </documentation>
  7126. </annotation>
  7127. </element>
  7128. </sequence>
  7129. </complexType>
  7130. <complexType name="ExecuteCheckoutOperationsResponseDetailsType">
  7131. <sequence>
  7132. <element name="SetDataResponse" type="ns:SetDataResponseType" minOccurs="1" />
  7133. <element name="AuthorizationResponse" type="ns:AuthorizationResponseType" minOccurs="0" />
  7134. </sequence>
  7135. </complexType>
  7136. <complexType name="SetDataResponseType">
  7137. <xs:sequence>
  7138. <element name="Token" type="ns:ExpressCheckoutTokenType" minOccurs="0" maxOccurs="1">
  7139. <annotation>
  7140. <documentation>
  7141. If Checkout session was initialized successfully, the corresponding token is returned in this element.
  7142. </documentation>
  7143. </annotation>
  7144. </element>
  7145. <element name="SetDataError" type="ns:ErrorType" minOccurs="0" maxOccurs="unbounded"/>
  7146. </xs:sequence>
  7147. </complexType>
  7148. <complexType name="AuthorizationResponseType">
  7149. <xs:sequence>
  7150. <element name="Status" type="ns:AckCodeType" minOccurs="1">
  7151. <annotation>
  7152. <documentation>
  7153. Status will denote whether Auto authorization was successful or not.
  7154. </documentation>
  7155. </annotation>
  7156. </element>
  7157. <element name="AuthorizationError" type="ns:ErrorType" minOccurs="0" maxOccurs="unbounded"/>
  7158. </xs:sequence>
  7159. </complexType>
  7160. <complexType name="DoExpressCheckoutPaymentRequestDetailsType">
  7161. <sequence>
  7162. <element name="PaymentAction" type="ns:PaymentActionCodeType" minOccurs="0" maxOccurs="1">
  7163. <annotation>
  7164. <documentation>
  7165. How you want to obtain payment.
  7166. <br/>
  7167. <br/>
  7168. <b>Required</b>
  7169. <br/>
  7170. <br/>
  7171. Authorization indicates that this payment is a basic authorization subject to settlement with PayPal Authorization and Capture.
  7172. <br/>
  7173. <br/>
  7174. Order indicates that this payment is is an order authorization subject to settlement with PayPal Authorization and Capture.
  7175. <br/>
  7176. <br/>
  7177. Sale indicates that this is a final sale for which you are requesting payment.
  7178. <br/>
  7179. <br/>
  7180. IMPORTANT: You cannot set PaymentAction to Sale on SetExpressCheckoutRequest and then change PaymentAction to Authorization on the final Express Checkout API, DoExpressCheckoutPaymentRequest.
  7181. <br/>
  7182. <br/>
  7183. Character length and limit: Up to 13 single-byte alphabetic characters
  7184. </documentation>
  7185. </annotation>
  7186. </element>
  7187. <element name="Token" type="ns:ExpressCheckoutTokenType">
  7188. <annotation>
  7189. <documentation>
  7190. The timestamped token value that was returned by SetExpressCheckoutResponse and passed on GetExpressCheckoutDetailsRequest.
  7191. <br/>
  7192. <br/>
  7193. <b>Required</b>
  7194. <br/>
  7195. <br/>
  7196. Character length and limitations: 20 single-byte characters</documentation>
  7197. </annotation>
  7198. </element>
  7199. <element name="PayerID" type="ns:UserIDType">
  7200. <annotation>
  7201. <documentation>
  7202. Encrypted PayPal customer account identification number as returned by GetExpressCheckoutDetailsResponse.
  7203. <br/>
  7204. <br/>
  7205. <b>Required</b>
  7206. <br/>
  7207. <br/>
  7208. Character length and limitations: 127 single-byte characters.
  7209. </documentation>
  7210. </annotation>
  7211. </element>
  7212. <element name="OrderURL" type="xs:string" minOccurs="0" maxOccurs="1">
  7213. <annotation>
  7214. <documentation>
  7215. URL on Merchant site pertaining to this invoice.
  7216. <br/>
  7217. <br/>
  7218. <b>Optional</b>
  7219. <br/>
  7220. <br/>
  7221. </documentation>
  7222. </annotation>
  7223. </element>
  7224. <element name="PaymentDetails" type="ns:PaymentDetailsType" minOccurs="0" maxOccurs="10">
  7225. <annotation>
  7226. <documentation>
  7227. Information about the payment
  7228. <br/>
  7229. <br/>
  7230. <b>Required</b>
  7231. </documentation>
  7232. </annotation>
  7233. </element>
  7234. <element name="PromoOverrideFlag" type="xs:string" minOccurs="0" maxOccurs="1">
  7235. <annotation>
  7236. <documentation>
  7237. Flag to indicate if previously set promoCode shall be overriden. Value 1 indicates overriding.
  7238. </documentation>
  7239. </annotation>
  7240. </element>
  7241. <element name="PromoCode" type="xs:string" minOccurs="0" maxOccurs="1">
  7242. <annotation>
  7243. <documentation>
  7244. Promotional financing code for item. Overrides any previous PromoCode setting.
  7245. </documentation>
  7246. </annotation>
  7247. </element>
  7248. <element name="EnhancedData" type="ns:EnhancedDataType" minOccurs="0" maxOccurs="1">
  7249. <annotation>
  7250. <documentation>
  7251. Contains data for enhanced data like Airline Itinerary Data.
  7252. </documentation>
  7253. </annotation>
  7254. </element>
  7255. <element name="SoftDescriptor" type="xs:string" minOccurs="0">
  7256. <annotation>
  7257. <documentation>
  7258. Soft Descriptor supported for Sale and Auth in DEC only. For Order this will be ignored.
  7259. </documentation>
  7260. </annotation>
  7261. </element>
  7262. <element name="UserSelectedOptions" type="ns:UserSelectedOptionType" minOccurs="0" maxOccurs="1">
  7263. <annotation>
  7264. <documentation>
  7265. Information about the user selected options.
  7266. </documentation>
  7267. </annotation>
  7268. </element>
  7269. <element name="GiftMessage" type="xs:string" minOccurs="0" maxOccurs="1">
  7270. <annotation>
  7271. <documentation>
  7272. Information about the Gift message.
  7273. </documentation>
  7274. </annotation>
  7275. </element>
  7276. <element name="GiftReceiptEnable" type="xs:string" minOccurs="0" maxOccurs="1">
  7277. <annotation>
  7278. <documentation>
  7279. Information about the Gift receipt enable.
  7280. </documentation>
  7281. </annotation>
  7282. </element>
  7283. <element name="GiftWrapName" type="xs:string" minOccurs="0" maxOccurs="1">
  7284. <annotation>
  7285. <documentation>
  7286. Information about the Gift Wrap name.
  7287. </documentation>
  7288. </annotation>
  7289. </element>
  7290. <element name="GiftWrapAmount" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  7291. <annotation>
  7292. <documentation>
  7293. Information about the Gift Wrap amount.
  7294. </documentation>
  7295. </annotation>
  7296. </element>
  7297. <element name="BuyerMarketingEmail" type="xs:string" minOccurs="0" maxOccurs="1">
  7298. <annotation>
  7299. <documentation>
  7300. Information about the Buyer marketing email.
  7301. </documentation>
  7302. </annotation>
  7303. </element>
  7304. <element name="SurveyQuestion" type="xs:string" minOccurs="0" maxOccurs="1">
  7305. <annotation>
  7306. <documentation>
  7307. Information about the survey question.
  7308. </documentation>
  7309. </annotation>
  7310. </element>
  7311. <element name="SurveyChoiceSelected" type="xs:string" minOccurs="0" maxOccurs="unbounded">
  7312. <annotation>
  7313. <documentation>
  7314. Information about the survey choice selected by the user.
  7315. </documentation>
  7316. </annotation>
  7317. </element>
  7318. <element name="ButtonSource" type="xs:string" minOccurs="0">
  7319. <annotation>
  7320. <documentation>An identification code for use by third-party applications to identify transactions.
  7321. <br/>
  7322. <br/>
  7323. Optional
  7324. <br/>
  7325. <br/>
  7326. Character length and limitations: 32 single-byte alphanumeric characters
  7327. </documentation>
  7328. </annotation>
  7329. </element>
  7330. <element name="SkipBACreation" type="xs:boolean" minOccurs="0" maxOccurs="1">
  7331. <annotation>
  7332. <documentation>
  7333. Merchant specified flag which indicates whether to create billing agreement as part of DoEC or not.
  7334. <br/>
  7335. <br/>
  7336. <b>Optional</b>
  7337. <br/>
  7338. <br/>
  7339. </documentation>
  7340. </annotation>
  7341. </element>
  7342. </sequence>
  7343. </complexType>
  7344. <complexType name="DoExpressCheckoutPaymentResponseDetailsType">
  7345. <sequence>
  7346. <element name="Token" type="ns:ExpressCheckoutTokenType">
  7347. <annotation>
  7348. <documentation>
  7349. The timestamped token value that was returned by SetExpressCheckoutResponse and passed on GetExpressCheckoutDetailsRequest.
  7350. <br/>
  7351. <br/>
  7352. Character length and limitations:20 single-byte characters
  7353. </documentation>
  7354. </annotation>
  7355. </element>
  7356. <element name="PaymentInfo" type="ns:PaymentInfoType" minOccurs="0" maxOccurs="10">
  7357. <annotation>
  7358. <documentation>Information about the transaction </documentation>
  7359. </annotation>
  7360. </element>
  7361. <element name="BillingAgreementID" type="xs:string" minOccurs="0" maxOccurs="1">
  7362. <annotation>
  7363. <documentation>
  7364. </documentation>
  7365. </annotation>
  7366. </element>
  7367. <element name="RedirectRequired" type="xs:string" minOccurs="0" maxOccurs="1">
  7368. <annotation>
  7369. <documentation>
  7370. </documentation>
  7371. </annotation>
  7372. </element>
  7373. <element name="Note" type="xs:string" minOccurs="0" maxOccurs="1">
  7374. <annotation>
  7375. <documentation>Memo entered by sender in PayPal Review Page note field.
  7376. <br/>
  7377. <br/>
  7378. Optional
  7379. <br/>
  7380. <br/>
  7381. Character length and limitations: 255 single-byte alphanumeric characters
  7382. </documentation>
  7383. </annotation>
  7384. </element>
  7385. <element name="SuccessPageRedirectRequested" type="xs:string" minOccurs="0" maxOccurs="1">
  7386. <annotation>
  7387. <documentation>
  7388. Redirect back to PayPal, PayPal can host the success page.
  7389. </documentation>
  7390. </annotation>
  7391. </element>
  7392. <element name="UserSelectedOptions" type="ns:UserSelectedOptionType" minOccurs="0" maxOccurs="1">
  7393. <annotation>
  7394. <documentation>
  7395. Information about the user selected options.
  7396. </documentation>
  7397. </annotation>
  7398. </element>
  7399. </sequence>
  7400. </complexType>
  7401. <complexType name="DoCaptureResponseDetailsType">
  7402. <sequence>
  7403. <element ref="ns:AuthorizationID">
  7404. <annotation>
  7405. <documentation>The authorization identification number you specified in the request.
  7406. <br/>Character length and limits: 19 single-byte characters maximum
  7407. </documentation>
  7408. </annotation>
  7409. </element>
  7410. <element name="PaymentInfo" type="ns:PaymentInfoType">
  7411. <annotation>
  7412. <documentation>Information about the transaction </documentation>
  7413. </annotation>
  7414. </element>
  7415. </sequence>
  7416. </complexType>
  7417. <complexType name="DoDirectPaymentRequestDetailsType">
  7418. <sequence>
  7419. <element name="PaymentAction" type="ns:PaymentActionCodeType">
  7420. <annotation>
  7421. <documentation>
  7422. How you want to obtain payment.
  7423. <br/>
  7424. <br/>
  7425. <b>Required</b>
  7426. <br/>
  7427. <br/>
  7428. Authorization indicates that this payment is a basic authorization subject to settlement with PayPal Authorization and Capture.
  7429. <br/>
  7430. <br/>
  7431. Sale indicates that this is a final sale for which you are requesting payment.
  7432. <br/>
  7433. <br/>
  7434. NOTE: Order is not allowed for Direct Payment.
  7435. <br/>
  7436. <br/>
  7437. Character length and limit: Up to 13 single-byte alphabetic characters</documentation>
  7438. </annotation>
  7439. </element>
  7440. <element name="PaymentDetails" type="ns:PaymentDetailsType">
  7441. <annotation>
  7442. <documentation>
  7443. Information about the payment
  7444. <br/>
  7445. <br/>
  7446. <b>Required</b>
  7447. <br/>
  7448. <br/>
  7449. </documentation>
  7450. </annotation>
  7451. </element>
  7452. <element name="CreditCard" type="ns:CreditCardDetailsType">
  7453. <annotation>
  7454. <documentation>
  7455. Information about the credit card to be charged.
  7456. <br/>
  7457. <br/>
  7458. <b>Required</b>
  7459. <br/>
  7460. <br/>
  7461. </documentation>
  7462. </annotation>
  7463. </element>
  7464. <element name="IPAddress" type="xs:string">
  7465. <annotation>
  7466. <documentation>
  7467. 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.
  7468. <br/>
  7469. <br/>
  7470. <b>Required</b>
  7471. <br/>
  7472. <br/>Character length and limitations: 15 single-byte characters, including periods, in dotted-quad format: ???.???.???.???
  7473. </documentation>
  7474. </annotation>
  7475. </element>
  7476. <element name="MerchantSessionId" type="xs:string" minOccurs="0">
  7477. <annotation>
  7478. <documentation>
  7479. Your customer session identification token. PayPal records this optional session identification token as an additional means to detect possible fraud.
  7480. <br/>
  7481. <br/>
  7482. Optional
  7483. <br/>
  7484. <br/>Character length and limitations: 64 single-byte numeric characters</documentation>
  7485. </annotation>
  7486. </element>
  7487. <element name="ReturnFMFDetails" type="xs:boolean" minOccurs="0" maxOccurs="1">
  7488. <annotation>
  7489. <documentation>
  7490. </documentation>
  7491. </annotation>
  7492. </element>
  7493. </sequence>
  7494. </complexType>
  7495. <complexType name="CreateMobilePaymentRequestDetailsType">
  7496. <sequence>
  7497. <element name="PaymentType" type="ns:MobilePaymentCodeType">
  7498. <annotation>
  7499. <documentation>Type of the payment
  7500. <br/>
  7501. <br/>
  7502. <b>Required</b>
  7503. </documentation>
  7504. </annotation>
  7505. </element>
  7506. <element name="PaymentAction" type="ns:PaymentActionCodeType">
  7507. <annotation>
  7508. <documentation>
  7509. How you want to obtain payment. Defaults to Sale.
  7510. <br/>
  7511. <br/>
  7512. <b>Optional</b>
  7513. <br/>
  7514. <br/>
  7515. Authorization indicates that this payment is a basic authorization subject to settlement with PayPal Authorization and Capture.
  7516. <br/>
  7517. <br/>
  7518. Sale indicates that this is a final sale for which you are requesting payment.
  7519. <br/>
  7520. <br/>
  7521. </documentation>
  7522. </annotation>
  7523. </element>
  7524. <element name="SenderPhone" type="ns:PhoneNumberType">
  7525. <annotation>
  7526. <documentation>Phone number of the user making the payment.
  7527. <br/>
  7528. <br/>
  7529. <b>Required</b>
  7530. <br/>
  7531. </documentation>
  7532. </annotation>
  7533. </element>
  7534. <element name="RecipientType" type="ns:MobileRecipientCodeType">
  7535. <annotation>
  7536. <documentation>Type of recipient specified, i.e., phone number or email address
  7537. <br/>
  7538. <br/>
  7539. <b>Required</b>
  7540. </documentation>
  7541. </annotation>
  7542. </element>
  7543. <element name="RecipientEmail" type="xs:string" minOccurs="0">
  7544. <annotation>
  7545. <documentation>Email address of the recipient
  7546. <br/>
  7547. <br/>
  7548. </documentation>
  7549. </annotation>
  7550. </element>
  7551. <element name="RecipientPhone" type="ns:PhoneNumberType" minOccurs="0">
  7552. <annotation>
  7553. <documentation>Phone number of the recipipent
  7554. <br/>
  7555. <br/>
  7556. <b>Required</b>
  7557. <br/>
  7558. </documentation>
  7559. </annotation>
  7560. </element>
  7561. <element name="ItemAmount" type="cc:BasicAmountType">
  7562. <annotation>
  7563. <documentation>Amount of item before tax and shipping
  7564. <br/>
  7565. <br/>
  7566. </documentation>
  7567. </annotation>
  7568. </element>
  7569. <element name="Tax" type="cc:BasicAmountType" minOccurs="0">
  7570. <annotation>
  7571. <documentation>The tax charged on the transaction
  7572. Tax
  7573. <br/>
  7574. <br/>
  7575. Optional
  7576. <br/>
  7577. </documentation>
  7578. </annotation>
  7579. </element>
  7580. <element name="Shipping" type="cc:BasicAmountType" minOccurs="0">
  7581. <annotation>
  7582. <documentation>Per-transaction shipping charge
  7583. <br/>
  7584. <br/>
  7585. Optional
  7586. <br/>
  7587. </documentation>
  7588. </annotation>
  7589. </element>
  7590. <element name="ItemName" type="xs:string" minOccurs="0">
  7591. <annotation>
  7592. <documentation>Name of the item being ordered
  7593. <br/>
  7594. <br/>
  7595. Optional
  7596. <br/>
  7597. <br/>
  7598. Character length and limitations: 255 single-byte alphanumeric characters
  7599. </documentation>
  7600. </annotation>
  7601. </element>
  7602. <element name="ItemNumber" type="xs:string" minOccurs="0">
  7603. <annotation>
  7604. <documentation>SKU of the item being ordered
  7605. <br/>
  7606. <br/>
  7607. Optional
  7608. <br/>
  7609. <br/>
  7610. Character length and limitations: 255 single-byte alphanumeric characters
  7611. </documentation>
  7612. </annotation>
  7613. </element>
  7614. <element name="Note" type="xs:string" minOccurs="0">
  7615. <annotation>
  7616. <documentation>Memo entered by sender in PayPal Website Payments note field.
  7617. <br/>
  7618. <br/>
  7619. Optional
  7620. <br/>
  7621. <br/>
  7622. Character length and limitations: 255 single-byte alphanumeric characters
  7623. </documentation>
  7624. </annotation>
  7625. </element>
  7626. <element name="CustomID" type="xs:string" minOccurs="0">
  7627. <annotation>
  7628. <documentation>Unique ID for the order. Required for non-P2P transactions
  7629. <br/>
  7630. <br/>
  7631. Optional
  7632. <br/>
  7633. <br/>
  7634. Character length and limitations: 255 single-byte alphanumeric characters
  7635. </documentation>
  7636. </annotation>
  7637. </element>
  7638. <element name="SharePhoneNumber" type="xs:integer" minOccurs="0">
  7639. <annotation>
  7640. <documentation>Indicates whether the sender's phone number will be shared with recipient
  7641. <br/>
  7642. <br/>
  7643. Optional
  7644. <br/>
  7645. </documentation>
  7646. </annotation>
  7647. </element>
  7648. <element name="ShareHomeAddress" type="xs:integer" minOccurs="0">
  7649. <annotation>
  7650. <documentation>Indicates whether the sender's home address will be shared with recipient
  7651. <br/>
  7652. <br/>
  7653. Optional
  7654. <br/>
  7655. </documentation>
  7656. </annotation>
  7657. </element>
  7658. </sequence>
  7659. </complexType>
  7660. <complexType name="GetMobileStatusRequestDetailsType">
  7661. <sequence>
  7662. <element name="Phone" type="ns:PhoneNumberType">
  7663. <annotation>
  7664. <documentation>Phone number for status inquiry </documentation>
  7665. </annotation>
  7666. </element>
  7667. </sequence>
  7668. </complexType>
  7669. <complexType name="SetAuthFlowParamRequestDetailsType">
  7670. <sequence>
  7671. <element name="ReturnURL" type="xs:string">
  7672. <annotation>
  7673. <documentation>URL to which the customer's browser is returned after choosing to login with PayPal.
  7674. <br/>
  7675. <br/>
  7676. <b>Required</b>
  7677. <br/>
  7678. <br/>
  7679. Character length and limitations: no limit. </documentation>
  7680. </annotation>
  7681. </element>
  7682. <element name="CancelURL" type="xs:string">
  7683. <annotation>
  7684. <documentation>URL to which the customer is returned if he does not approve the use of PayPal login.
  7685. <br/>
  7686. <br/>
  7687. <b>Required</b>
  7688. <br/>
  7689. <br/>
  7690. Character length and limitations: no limit
  7691. </documentation>
  7692. </annotation>
  7693. </element>
  7694. <element name="LogoutURL" type="xs:string">
  7695. <annotation>
  7696. <documentation>URL to which the customer's browser is returned after user logs out from PayPal.
  7697. <br/>
  7698. <br/>
  7699. <b>Required</b>
  7700. <br/>
  7701. <br/>
  7702. Character length and limitations: no limit. </documentation>
  7703. </annotation>
  7704. </element>
  7705. <element name="InitFlowType" type="xs:string" minOccurs="0">
  7706. <annotation>
  7707. <documentation>The type of the flow.
  7708. <br/>
  7709. <br/>
  7710. Optional
  7711. <br/>
  7712. <br/>Character length and limitations: 127 single-byte alphanumeric characters
  7713. </documentation>
  7714. </annotation>
  7715. </element>
  7716. <element name="SkipLoginPage" type="xs:string" minOccurs="0">
  7717. <annotation>
  7718. <documentation>The used to decide SkipLogin allowed or not.
  7719. <br/>
  7720. <br/>
  7721. Optional
  7722. <br/>
  7723. <br/>Character length and limitations: 127 single-byte alphanumeric characters
  7724. </documentation>
  7725. </annotation>
  7726. </element>
  7727. <element name="ServiceName1" type="xs:string" minOccurs="0">
  7728. <annotation>
  7729. <documentation>The name of the field Merchant requires from PayPal after user's login.
  7730. <br/>
  7731. <br/>
  7732. Optional
  7733. <br/>
  7734. <br/>Character length and limitations: 256 single-byte alphanumeric characters
  7735. </documentation>
  7736. </annotation>
  7737. </element>
  7738. <element name="ServiceDefReq1" type="xs:string" minOccurs="0">
  7739. <annotation>
  7740. <documentation>Whether the field is required, opt-in or opt-out.
  7741. <br/>
  7742. <br/>
  7743. Optional
  7744. <br/>
  7745. <br/>Character length and limitations: 127 single-byte alphanumeric characters
  7746. </documentation>
  7747. </annotation>
  7748. </element>
  7749. <element name="ServiceName2" type="xs:string" minOccurs="0">
  7750. <annotation>
  7751. <documentation>The name of the field Merchant requires from PayPal after user's login.
  7752. <br/>
  7753. <br/>
  7754. Optional
  7755. <br/>
  7756. <br/>Character length and limitations: 256 single-byte alphanumeric characters
  7757. </documentation>
  7758. </annotation>
  7759. </element>
  7760. <element name="ServiceDefReq2" type="xs:string" minOccurs="0">
  7761. <annotation>
  7762. <documentation>Whether the field is required, opt-in or opt-out.
  7763. <br/>
  7764. <br/>
  7765. Optional
  7766. <br/>
  7767. <br/>Character length and limitations: 127 single-byte alphanumeric characters
  7768. </documentation>
  7769. </annotation>
  7770. </element>
  7771. <element name="LocaleCode" type="xs:string" minOccurs="0">
  7772. <annotation>
  7773. <documentation>
  7774. Locale of pages displayed by PayPal during Authentication Login.
  7775. <br/>
  7776. <br/>
  7777. Optional
  7778. <br/>
  7779. <br/>
  7780. Character length and limitations: Five single-byte alphabetic characters, upper- or lowercase.
  7781. <br/>
  7782. <br/>
  7783. Allowable values:
  7784. <br/>
  7785. AU or en_AU
  7786. <br/>
  7787. DE or de_DE
  7788. <br/>
  7789. FR or fr_FR
  7790. <br/>
  7791. GB or en_GB
  7792. <br/>
  7793. IT or it_IT
  7794. <br/>
  7795. JP or ja_JP
  7796. <br/>
  7797. US or en_US
  7798. </documentation>
  7799. </annotation>
  7800. </element>
  7801. <element name="PageStyle" type="xs:string" minOccurs="0">
  7802. <annotation>
  7803. <documentation>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.
  7804. <br/>
  7805. <br/>
  7806. Optional
  7807. <br/>
  7808. <br/>Character length and limitations: 30 single-byte alphabetic characters.
  7809. </documentation>
  7810. </annotation>
  7811. </element>
  7812. <element name="cpp-header-image" type="xs:string" minOccurs="0">
  7813. <annotation>
  7814. <documentation>
  7815. 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.
  7816. <br/>
  7817. <br/>
  7818. Optional
  7819. <br/>
  7820. <br/>
  7821. Character length and limitations: 127
  7822. </documentation>
  7823. </annotation>
  7824. </element>
  7825. <element name="cpp-header-border-color" type="xs:string" minOccurs="0">
  7826. <annotation>
  7827. <documentation>
  7828. 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.
  7829. <br/>
  7830. <br/>
  7831. Optional
  7832. <br/>
  7833. <br/>Character length and limitations: Six character HTML hexadecimal color code in ASCII
  7834. </documentation>
  7835. </annotation>
  7836. </element>
  7837. <element name="cpp-header-back-color" type="xs:string" minOccurs="0">
  7838. <annotation>
  7839. <documentation>
  7840. Sets the background color for the header of the flow page.
  7841. <br/>
  7842. <br/>
  7843. Optional
  7844. <br/>
  7845. <br/>Character length and limitation: Six character HTML hexadecimal color code in ASCII
  7846. </documentation>
  7847. </annotation>
  7848. </element>
  7849. <element name="cpp-payflow-color" type="xs:string" minOccurs="0">
  7850. <annotation>
  7851. <documentation>
  7852. Sets the background color for the payment page.
  7853. <br/>
  7854. <br/>
  7855. Optional
  7856. <br/>
  7857. <br/>Character length and limitation: Six character HTML hexadecimal color code in ASCII
  7858. </documentation>
  7859. </annotation>
  7860. </element>
  7861. <element name="FirstName" type="xs:string" minOccurs="0">
  7862. <annotation>
  7863. <documentation>First Name of the user, this information is used if user chooses to signup with PayPal.
  7864. <br/>
  7865. <br/>
  7866. Optional
  7867. <br/>
  7868. <br/>Character length and limitation: Six character HTML hexadecimal color code in ASCII
  7869. </documentation>
  7870. </annotation>
  7871. </element>
  7872. <element name="LastName" type="xs:string" minOccurs="0">
  7873. <annotation>
  7874. <documentation>Last Name of the user, this information is used if user chooses to signup with PayPal.
  7875. <br/>
  7876. <br/>
  7877. Optional
  7878. <br/>
  7879. <br/>Character length and limitation: Six character HTML hexadecimal color code in ASCII
  7880. </documentation>
  7881. </annotation>
  7882. </element>
  7883. <element name="Address" type="ns:AddressType" minOccurs="0">
  7884. <annotation>
  7885. <documentation>User address, this information is used when user chooses to signup for PayPal.
  7886. <br/>
  7887. <br/>
  7888. Optional
  7889. <br/>
  7890. <br/>
  7891. If you include a shipping address and set the AddressOverride element on the request, PayPal returns this same address in GetExpressCheckoutDetailsResponse.
  7892. </documentation>
  7893. </annotation>
  7894. </element>
  7895. </sequence>
  7896. </complexType>
  7897. <complexType name="GetAuthDetailsResponseDetailsType">
  7898. <sequence>
  7899. <element name="FirstName" type="xs:string" minOccurs="0">
  7900. <annotation>
  7901. <documentation>The first name of the User.
  7902. <br/>
  7903. <br/>Character length and limitations: 127 single-byte alphanumeric characters</documentation>
  7904. </annotation>
  7905. </element>
  7906. <element name="LastName" type="xs:string" minOccurs="0">
  7907. <annotation>
  7908. <documentation>The Last name of the user.
  7909. <br/>
  7910. <br/>Character length and limitations: 127 single-byte alphanumeric characters
  7911. </documentation>
  7912. </annotation>
  7913. </element>
  7914. <element name="Email" type="xs:string" minOccurs="0">
  7915. <annotation>
  7916. <documentation>
  7917. The email address of the user.
  7918. <br/>Character length and limitations: 256 single-byte alphanumeric characters.
  7919. </documentation>
  7920. </annotation>
  7921. </element>
  7922. <element name="PayerID" type="ns:UserIDType">
  7923. <annotation>
  7924. <documentation>
  7925. Encrypted PayPal customer account identification number.
  7926. <br/>
  7927. <br/>
  7928. <b>Required</b>
  7929. <br/>
  7930. <br/>
  7931. Character length and limitations: 127 single-byte characters.
  7932. </documentation>
  7933. </annotation>
  7934. </element>
  7935. </sequence>
  7936. </complexType>
  7937. <complexType name="SetAccessPermissionsRequestDetailsType">
  7938. <sequence>
  7939. <element name="ReturnURL" type="xs:string">
  7940. <annotation>
  7941. <documentation>URL to which the customer's browser is returned after choosing to login with PayPal.
  7942. <br/>
  7943. <br/>
  7944. <b>Required</b>
  7945. <br/>
  7946. <br/>
  7947. Character length and limitations: no limit.
  7948. </documentation>
  7949. </annotation>
  7950. </element>
  7951. <element name="CancelURL" type="xs:string">
  7952. <annotation>
  7953. <documentation>URL to which the customer is returned if he does not approve the use of PayPal login.
  7954. <br/>
  7955. <br/>
  7956. <b>Required</b>
  7957. <br/>
  7958. <br/>
  7959. Character length and limitations: no limit
  7960. </documentation>
  7961. </annotation>
  7962. </element>
  7963. <element name="LogoutURL" type="xs:string">
  7964. <annotation>
  7965. <documentation>URL to which the customer's browser is returned after user logs out from PayPal.
  7966. <br/>
  7967. <br/>
  7968. <b>Required</b>
  7969. <br/>
  7970. <br/>
  7971. Character length and limitations: no limit.
  7972. </documentation>
  7973. </annotation>
  7974. </element>
  7975. <element name="InitFlowType" type="xs:string" minOccurs="0">
  7976. <annotation>
  7977. <documentation>The type of the flow.
  7978. <br/>
  7979. <br/>
  7980. Optional
  7981. <br/>
  7982. <br/>Character length and limitations: 127 single-byte alphanumeric characters
  7983. </documentation>
  7984. </annotation>
  7985. </element>
  7986. <element name="SkipLoginPage" type="xs:string" minOccurs="0">
  7987. <annotation>
  7988. <documentation>The used to decide SkipLogin allowed or not.
  7989. <br/>
  7990. <br/>
  7991. Optional
  7992. <br/>
  7993. <br/>Character length and limitations: 127 single-byte alphanumeric characters
  7994. </documentation>
  7995. </annotation>
  7996. </element>
  7997. <element name="RequiredAccessPermissions" type="xs:string" minOccurs="0" maxOccurs="unbounded">
  7998. <annotation>
  7999. <documentation>
  8000. contains information about API Services
  8001. </documentation>
  8002. </annotation>
  8003. </element>
  8004. <element name="OptionalAccessPermissions" type="xs:string" minOccurs="0" maxOccurs="unbounded">
  8005. <annotation>
  8006. <documentation>
  8007. contains information about API Services
  8008. </documentation>
  8009. </annotation>
  8010. </element>
  8011. <element name="LocaleCode" type="xs:string" minOccurs="0">
  8012. <annotation>
  8013. <documentation>
  8014. Locale of pages displayed by PayPal during Authentication Login.
  8015. <br/>
  8016. <br/>
  8017. Optional
  8018. <br/>
  8019. <br/>
  8020. Character length and limitations: Five single-byte alphabetic characters, upper- or lowercase.
  8021. <br/>
  8022. <br/>
  8023. Allowable values:
  8024. <br/>
  8025. AU or en_AU
  8026. <br/>
  8027. DE or de_DE
  8028. <br/>
  8029. FR or fr_FR
  8030. <br/>
  8031. GB or en_GB
  8032. <br/>
  8033. IT or it_IT
  8034. <br/>
  8035. JP or ja_JP
  8036. <br/>
  8037. US or en_US
  8038. </documentation>
  8039. </annotation>
  8040. </element>
  8041. <element name="PageStyle" type="xs:string" minOccurs="0">
  8042. <annotation>
  8043. <documentation>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.
  8044. <br/>
  8045. <br/>
  8046. Optional
  8047. <br/>
  8048. <br/>Character length and limitations: 30 single-byte alphabetic characters.
  8049. </documentation>
  8050. </annotation>
  8051. </element>
  8052. <element name="cpp-header-image" type="xs:string" minOccurs="0">
  8053. <annotation>
  8054. <documentation>
  8055. 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.
  8056. <br/>
  8057. <br/>
  8058. Optional
  8059. <br/>
  8060. <br/>
  8061. Character length and limitations: 127
  8062. </documentation>
  8063. </annotation>
  8064. </element>
  8065. <element name="cpp-header-border-color" type="xs:string" minOccurs="0">
  8066. <annotation>
  8067. <documentation>
  8068. 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.
  8069. <br/>
  8070. <br/>
  8071. Optional
  8072. <br/>
  8073. <br/>Character length and limitations: Six character HTML hexadecimal color code in ASCII
  8074. </documentation>
  8075. </annotation>
  8076. </element>
  8077. <element name="cpp-header-back-color" type="xs:string" minOccurs="0">
  8078. <annotation>
  8079. <documentation>
  8080. Sets the background color for the header of the flow page.
  8081. <br/>
  8082. <br/>
  8083. Optional
  8084. <br/>
  8085. <br/>Character length and limitation: Six character HTML hexadecimal color code in ASCII
  8086. </documentation>
  8087. </annotation>
  8088. </element>
  8089. <element name="cpp-payflow-color" type="xs:string" minOccurs="0">
  8090. <annotation>
  8091. <documentation>
  8092. Sets the background color for the payment page.
  8093. <br/>
  8094. <br/>
  8095. Optional
  8096. <br/>
  8097. <br/>Character length and limitation: Six character HTML hexadecimal color code in ASCII
  8098. </documentation>
  8099. </annotation>
  8100. </element>
  8101. <element name="FirstName" type="xs:string" minOccurs="0">
  8102. <annotation>
  8103. <documentation>First Name of the user, this information is used if user chooses to signup with PayPal.
  8104. <br/>
  8105. <br/>
  8106. Optional
  8107. <br/>
  8108. <br/>Character length and limitation: Six character HTML hexadecimal color code in ASCII
  8109. </documentation>
  8110. </annotation>
  8111. </element>
  8112. <element name="LastName" type="xs:string" minOccurs="0">
  8113. <annotation>
  8114. <documentation>Last Name of the user, this information is used if user chooses to signup with PayPal.
  8115. <br/>
  8116. <br/>
  8117. Optional
  8118. <br/>
  8119. <br/>Character length and limitation: Six character HTML hexadecimal color code in ASCII
  8120. </documentation>
  8121. </annotation>
  8122. </element>
  8123. <element name="Address" type="ns:AddressType" minOccurs="0">
  8124. <annotation>
  8125. <documentation>User address, this information is used when user chooses to signup for PayPal.
  8126. <br/>
  8127. <br/>
  8128. Optional
  8129. <br/>
  8130. <br/>
  8131. If you include a shipping address and set the AddressOverride element on the request, PayPal returns this same address in GetExpressCheckoutDetailsResponse.
  8132. </documentation>
  8133. </annotation>
  8134. </element>
  8135. </sequence>
  8136. </complexType>
  8137. <complexType name="GetAccessPermissionDetailsResponseDetailsType">
  8138. <sequence>
  8139. <element name="FirstName" type="xs:string" minOccurs="0">
  8140. <annotation>
  8141. <documentation>The first name of the User.
  8142. <br/>
  8143. <br/>Character length and limitations: 127 single-byte alphanumeric characters</documentation>
  8144. </annotation>
  8145. </element>
  8146. <element name="LastName" type="xs:string" minOccurs="0">
  8147. <annotation>
  8148. <documentation>The Last name of the user.
  8149. <br/>
  8150. <br/>Character length and limitations: 127 single-byte alphanumeric characters
  8151. </documentation>
  8152. </annotation>
  8153. </element>
  8154. <element name="Email" type="xs:string" minOccurs="0">
  8155. <annotation>
  8156. <documentation>
  8157. The email address of the user.
  8158. <br/>Character length and limitations: 256 single-byte alphanumeric characters.
  8159. </documentation>
  8160. </annotation>
  8161. </element>
  8162. <element name="AccessPermissionName" type="xs:string" minOccurs="0" maxOccurs="unbounded">
  8163. <annotation>
  8164. <documentation>
  8165. contains information about API Services
  8166. </documentation>
  8167. </annotation>
  8168. </element>
  8169. <element name="AccessPermissionStatus" type="xs:string" minOccurs="0" maxOccurs="unbounded">
  8170. <annotation>
  8171. <documentation>
  8172. contains information about API Services
  8173. </documentation>
  8174. </annotation>
  8175. </element>
  8176. <element name="PayerID" type="ns:UserIDType">
  8177. <annotation>
  8178. <documentation>
  8179. Encrypted PayPal customer account identification number.
  8180. <br/>
  8181. <br/>
  8182. <b>Required</b>
  8183. <br/>
  8184. <br/>
  8185. Character length and limitations: 127 single-byte characters.
  8186. </documentation>
  8187. </annotation>
  8188. </element>
  8189. </sequence>
  8190. </complexType>
  8191. <complexType name="BAUpdateResponseDetailsType">
  8192. <sequence>
  8193. <element name="BillingAgreementID" type="xs:string" minOccurs="1" maxOccurs="1">
  8194. <annotation>
  8195. <documentation>
  8196. </documentation>
  8197. </annotation>
  8198. </element>
  8199. <element name="BillingAgreementDescription" type="xs:string" minOccurs="0" maxOccurs="1">
  8200. <annotation>
  8201. <documentation>
  8202. </documentation>
  8203. </annotation>
  8204. </element>
  8205. <element name="BillingAgreementStatus" type="ns:MerchantPullStatusCodeType" minOccurs="1" maxOccurs="1">
  8206. <annotation>
  8207. <documentation>
  8208. </documentation>
  8209. </annotation>
  8210. </element>
  8211. <element name="BillingAgreementCustom" type="xs:string" minOccurs="0" maxOccurs="1">
  8212. <annotation>
  8213. <documentation>
  8214. </documentation>
  8215. </annotation>
  8216. </element>
  8217. <element name="PayerInfo" type="ns:PayerInfoType" minOccurs="1" maxOccurs="1">
  8218. <annotation>
  8219. <documentation>
  8220. </documentation>
  8221. </annotation>
  8222. </element>
  8223. <element name="BillingAgreementMax" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  8224. <annotation>
  8225. <documentation>
  8226. </documentation>
  8227. </annotation>
  8228. </element>
  8229. <element name="BillingAddress" type="ns:AddressType" minOccurs="0">
  8230. <annotation>
  8231. <documentation>Customer's billing address.
  8232. <br/>
  8233. <br/>Optional
  8234. <br/>
  8235. If you have credit card mapped in your account then billing address of the
  8236. credit card is returned otherwise your primary address is returned , PayPal
  8237. returns this address in BAUpdateResponseDetails.
  8238. </documentation>
  8239. </annotation>
  8240. </element>
  8241. </sequence>
  8242. </complexType>
  8243. <complexType name="MerchantPullPaymentResponseType">
  8244. <annotation>
  8245. <documentation>
  8246. MerchantPullPaymentResponseType
  8247. Response data from the merchant pull.
  8248. </documentation>
  8249. </annotation>
  8250. <sequence>
  8251. <element name="PayerInfo" type="ns:PayerInfoType">
  8252. <annotation>
  8253. <documentation>
  8254. information about the customer</documentation>
  8255. </annotation>
  8256. </element>
  8257. <element name="PaymentInfo" type="ns:PaymentInfoType">
  8258. <annotation>
  8259. <documentation>Information about the transaction </documentation>
  8260. </annotation>
  8261. </element>
  8262. <element name="MerchantPullInfo" type="ns:MerchantPullInfoType">
  8263. <annotation>
  8264. <documentation>
  8265. Specific information about the preapproved payment </documentation>
  8266. </annotation>
  8267. </element>
  8268. </sequence>
  8269. </complexType>
  8270. <complexType name="MerchantPullInfoType">
  8271. <annotation>
  8272. <documentation>
  8273. MerchantPullInfoType
  8274. Information about the merchant pull.
  8275. </documentation>
  8276. </annotation>
  8277. <sequence>
  8278. <element name="MpStatus" type="ns:MerchantPullStatusCodeType">
  8279. <annotation>
  8280. <documentation>
  8281. Current status of billing agreement
  8282. </documentation>
  8283. </annotation>
  8284. </element>
  8285. <element name="MpMax" type="cc:BasicAmountType">
  8286. <annotation>
  8287. <documentation>Monthly maximum payment amount</documentation>
  8288. </annotation>
  8289. </element>
  8290. <element name="MpCustom" type="xs:string" minOccurs="0">
  8291. <annotation>
  8292. <documentation>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
  8293. </documentation>
  8294. </annotation>
  8295. </element>
  8296. <element name="Desc" type="xs:string" minOccurs="0">
  8297. <annotation>
  8298. <documentation>The value of the mp_desc variable (description of goods or services) associated with the billing agreement
  8299. </documentation>
  8300. </annotation>
  8301. </element>
  8302. <element name="Invoice" type="xs:string" minOccurs="0">
  8303. <annotation>
  8304. <documentation>Invoice value as set by BillUserRequest API call </documentation>
  8305. </annotation>
  8306. </element>
  8307. <element name="Custom" type="xs:string" minOccurs="0">
  8308. <annotation>
  8309. <documentation>Custom field as set by BillUserRequest API call </documentation>
  8310. </annotation>
  8311. </element>
  8312. <element name="PaymentSourceID" type="xs:string" minOccurs="0">
  8313. <annotation>
  8314. <documentation>Note: This field is no longer used and is always empty.</documentation>
  8315. </annotation>
  8316. </element>
  8317. </sequence>
  8318. </complexType>
  8319. <complexType name="PaymentTransactionSearchResultType">
  8320. <annotation>
  8321. <documentation>
  8322. PaymentTransactionSearchResultType
  8323. Results from a PaymentTransaction search
  8324. </documentation>
  8325. </annotation>
  8326. <sequence>
  8327. <element name="Timestamp" type="xs:dateTime">
  8328. <annotation>
  8329. <documentation>The date and time (in UTC/GMT format) the transaction occurred</documentation>
  8330. </annotation>
  8331. </element>
  8332. <element name="Timezone" type="xs:string">
  8333. <annotation>
  8334. <documentation>The time zone of the transaction </documentation>
  8335. </annotation>
  8336. </element>
  8337. <element name="Type" type="xs:string">
  8338. <annotation>
  8339. <documentation>The type of the transaction</documentation>
  8340. </annotation>
  8341. </element>
  8342. <element name="Payer" type="ns:EmailAddressType">
  8343. <annotation>
  8344. <documentation>The email address of the payer</documentation>
  8345. </annotation>
  8346. </element>
  8347. <element name="PayerDisplayName" type="xs:string">
  8348. <annotation>
  8349. <documentation>Display name of the payer</documentation>
  8350. </annotation>
  8351. </element>
  8352. <element ref="ns:TransactionID">
  8353. <annotation>
  8354. <documentation>The transaction ID of the seller</documentation>
  8355. </annotation>
  8356. </element>
  8357. <element name="Status" type="xs:string">
  8358. <annotation>
  8359. <documentation>The status of the transaction</documentation>
  8360. </annotation>
  8361. </element>
  8362. <element name="GrossAmount" type="cc:BasicAmountType">
  8363. <annotation>
  8364. <documentation>The total gross amount charged, including any profile shipping cost and taxes</documentation>
  8365. </annotation>
  8366. </element>
  8367. <element name="FeeAmount" type="cc:BasicAmountType">
  8368. <annotation>
  8369. <documentation>The fee that PayPal charged for the transaction </documentation>
  8370. </annotation>
  8371. </element>
  8372. <element name="NetAmount" type="cc:BasicAmountType">
  8373. <annotation>
  8374. <documentation>The net amount of the transaction </documentation>
  8375. </annotation>
  8376. </element>
  8377. </sequence>
  8378. </complexType>
  8379. <complexType name="ShippingInfoType">
  8380. <annotation>
  8381. <documentation>
  8382. </documentation>
  8383. </annotation>
  8384. <sequence>
  8385. <element name="ShippingMethod" type="xs:string"/>
  8386. <element name="ShippingCarrier" type="xs:string"/>
  8387. <element name="ShippingAmount" type="cc:BasicAmountType"/>
  8388. <element name="HandlingAmount" type="cc:BasicAmountType"/>
  8389. <element name="InsuranceAmount" type="cc:BasicAmountType"/>
  8390. </sequence>
  8391. </complexType>
  8392. <complexType name="TaxInfoType">
  8393. <annotation>
  8394. <documentation>
  8395. </documentation>
  8396. </annotation>
  8397. <sequence>
  8398. <element name="TaxAmount" type="cc:BasicAmountType"/>
  8399. <element name="SalesTaxPercentage" type="xs:string"/>
  8400. <element name="TaxState" type="xs:string"/>
  8401. </sequence>
  8402. </complexType>
  8403. <complexType name="MerchantPullPaymentType">
  8404. <annotation>
  8405. <documentation>
  8406. MerchantPullPayment
  8407. Parameters to make initiate a pull payment
  8408. </documentation>
  8409. </annotation>
  8410. <sequence>
  8411. <element name="Amount" type="cc:BasicAmountType">
  8412. <annotation>
  8413. <documentation>
  8414. The amount to charge to the customer.
  8415. <br/>
  8416. <br/>
  8417. <b>Required</b>
  8418. <br/>
  8419. <br/>
  8420. 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.
  8421. </documentation>
  8422. </annotation>
  8423. </element>
  8424. <element name="MpID" type="ns:MerchantPullIDType">
  8425. <annotation>
  8426. <documentation>
  8427. Preapproved Payments billing agreement identification number between the PayPal customer and you.
  8428. <br/>
  8429. <br/>
  8430. <b>Required</b>
  8431. <br/>
  8432. <br/>
  8433. Character limit: 19 single-byte alphanumeric characters.
  8434. <br/>
  8435. <br/>
  8436. The format of a billing agreement identification number is the single-character prefix B, followed by a hyphen and an alphanumeric character string:
  8437. <br/>
  8438. <br/>
  8439. B-unique_alphanumeric_string
  8440. </documentation>
  8441. </annotation>
  8442. </element>
  8443. <element name="PaymentType" type="ns:MerchantPullPaymentCodeType" minOccurs="0">
  8444. <annotation>
  8445. <documentation>Specifies type of PayPal payment you require
  8446. <br/>
  8447. <br/>
  8448. Optional
  8449. </documentation>
  8450. </annotation>
  8451. </element>
  8452. <element name="Memo" type="xs:string" minOccurs="0">
  8453. <annotation>
  8454. <documentation>Text entered by the customer in the Note field during enrollment
  8455. <br/>
  8456. <br/>
  8457. Optional
  8458. </documentation>
  8459. </annotation>
  8460. </element>
  8461. <element name="EmailSubject" type="xs:string" minOccurs="0">
  8462. <annotation>
  8463. <documentation>Subject line of confirmation email sent to recipient
  8464. <br/>
  8465. <br/>
  8466. Optional
  8467. </documentation>
  8468. </annotation>
  8469. </element>
  8470. <element name="Tax" type="cc:BasicAmountType" minOccurs="0">
  8471. <annotation>
  8472. <documentation>The tax charged on the transaction
  8473. <br/>
  8474. <br/>
  8475. Optional
  8476. </documentation>
  8477. </annotation>
  8478. </element>
  8479. <element name="Shipping" type="cc:BasicAmountType" minOccurs="0">
  8480. <annotation>
  8481. <documentation>Per-transaction shipping charge
  8482. <br/>
  8483. <br/>
  8484. Optional</documentation>
  8485. </annotation>
  8486. </element>
  8487. <element name="Handling" type="cc:BasicAmountType" minOccurs="0">
  8488. <annotation>
  8489. <documentation>Per-transaction handling charge
  8490. <br/>
  8491. <br/>
  8492. Optional</documentation>
  8493. </annotation>
  8494. </element>
  8495. <element name="ItemName" type="xs:string" minOccurs="0">
  8496. <annotation>
  8497. <documentation>Name of purchased item
  8498. <br/>
  8499. <br/>
  8500. Optional</documentation>
  8501. </annotation>
  8502. </element>
  8503. <element name="ItemNumber" type="xs:string" minOccurs="0">
  8504. <annotation>
  8505. <documentation>Reference number of purchased item
  8506. <br/>
  8507. <br/>
  8508. Optional</documentation>
  8509. </annotation>
  8510. </element>
  8511. <element name="Invoice" type="xs:string" minOccurs="0">
  8512. <annotation>
  8513. <documentation>Your invoice number
  8514. <br/>
  8515. <br/>
  8516. Optional
  8517. </documentation>
  8518. </annotation>
  8519. </element>
  8520. <element name="Custom" type="xs:string" minOccurs="0">
  8521. <annotation>
  8522. <documentation>Custom annotation field for tracking or other use
  8523. <br/>
  8524. <br/>
  8525. Optional
  8526. </documentation>
  8527. </annotation>
  8528. </element>
  8529. <element name="ButtonSource" type="xs:string" minOccurs="0">
  8530. <annotation>
  8531. <documentation>An identification code for use by third-party applications to identify transactions.
  8532. <br/>
  8533. <br/>
  8534. Optional
  8535. <br/>
  8536. <br/>
  8537. Character length and limitations: 32 single-byte alphanumeric characters
  8538. </documentation>
  8539. </annotation>
  8540. </element>
  8541. <element name="SoftDescriptor" type="xs:string" minOccurs="0">
  8542. <annotation>
  8543. <documentation>Passed in soft descriptor string to be appended.
  8544. <br/>
  8545. <br/>
  8546. Optional
  8547. <br/>
  8548. <br/>
  8549. Character length and limitations: single-byte alphanumeric characters
  8550. </documentation>
  8551. </annotation>
  8552. </element>
  8553. </sequence>
  8554. </complexType>
  8555. <complexType name="PaymentTransactionType">
  8556. <annotation>
  8557. <documentation>
  8558. PaymentTransactionType
  8559. Information about a PayPal payment from the seller side
  8560. </documentation>
  8561. </annotation>
  8562. <sequence>
  8563. <element name="ReceiverInfo" type="ns:ReceiverInfoType">
  8564. <annotation>
  8565. <documentation>Information about the recipient of the payment </documentation>
  8566. </annotation>
  8567. </element>
  8568. <element name="PayerInfo" type="ns:PayerInfoType">
  8569. <annotation>
  8570. <documentation>Information about the payer </documentation>
  8571. </annotation>
  8572. </element>
  8573. <element name="PaymentInfo" type="ns:PaymentInfoType">
  8574. <annotation>
  8575. <documentation>Information about the transaction </documentation>
  8576. </annotation>
  8577. </element>
  8578. <element name="PaymentItemInfo" type="ns:PaymentItemInfoType" minOccurs="0">
  8579. <annotation>
  8580. <documentation>Information about an individual item in the transaction</documentation>
  8581. </annotation>
  8582. </element>
  8583. <element name="UserSelectedOptions" type="ns:UserSelectedOptionType" minOccurs="0" maxOccurs="1">
  8584. <annotation>
  8585. <documentation>
  8586. Information about the user selected options.
  8587. </documentation>
  8588. </annotation>
  8589. </element>
  8590. <element name="GiftMessage" type="xs:string" minOccurs="0" maxOccurs="1">
  8591. <annotation>
  8592. <documentation>
  8593. Information about the Gift message.
  8594. </documentation>
  8595. </annotation>
  8596. </element>
  8597. <element name="GiftReceipt" type="xs:string" minOccurs="0" maxOccurs="1">
  8598. <annotation>
  8599. <documentation>
  8600. Information about the Gift receipt.
  8601. </documentation>
  8602. </annotation>
  8603. </element>
  8604. <element name="GiftWrapName" type="xs:string" minOccurs="0" maxOccurs="1">
  8605. <annotation>
  8606. <documentation>
  8607. Information about the Gift Wrap name.
  8608. </documentation>
  8609. </annotation>
  8610. </element>
  8611. <element name="GiftWrapAmount" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  8612. <annotation>
  8613. <documentation>
  8614. Information about the Gift Wrap amount.
  8615. </documentation>
  8616. </annotation>
  8617. </element>
  8618. <element name="BuyerEmailOptIn" type="xs:string" minOccurs="0" maxOccurs="1">
  8619. <annotation>
  8620. <documentation>
  8621. Information about the Buyer email.
  8622. </documentation>
  8623. </annotation>
  8624. </element>
  8625. <element name="SurveyQuestion" type="xs:string" minOccurs="0" maxOccurs="1">
  8626. <annotation>
  8627. <documentation>
  8628. Information about the survey question.
  8629. </documentation>
  8630. </annotation>
  8631. </element>
  8632. <element name="SurveyChoiceSelected" type="xs:string" minOccurs="0" maxOccurs="unbounded">
  8633. <annotation>
  8634. <documentation>
  8635. Information about the survey choice selected by the user.
  8636. </documentation>
  8637. </annotation>
  8638. </element>
  8639. </sequence>
  8640. </complexType>
  8641. <complexType name="ReceiverInfoType">
  8642. <annotation>
  8643. <documentation>
  8644. ReceiverInfoType
  8645. Receiver information.
  8646. </documentation>
  8647. </annotation>
  8648. <sequence>
  8649. <element name="Business" type="ns:EmailAddressType">
  8650. <annotation>
  8651. <documentation>
  8652. Email address or account ID of the payment recipient (the seller). Equivalent to Receiver if payment is sent to primary account.
  8653. <br/>Character length and limitations: 127 single-byte alphanumeric characters
  8654. </documentation>
  8655. </annotation>
  8656. </element>
  8657. <element name="Receiver" type="ns:EmailAddressType">
  8658. <annotation>
  8659. <documentation>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.
  8660. <br/>Character length and limitations: 127 single-byte alphanumeric characters
  8661. </documentation>
  8662. </annotation>
  8663. </element>
  8664. <element name="ReceiverID" type="ns:UserIDType">
  8665. <annotation>
  8666. <documentation>Unique account ID of the payment recipient (the seller). This value is the same as the value of the recipient's referral ID. </documentation>
  8667. </annotation>
  8668. </element>
  8669. </sequence>
  8670. </complexType>
  8671. <complexType name="PayerInfoType">
  8672. <annotation>
  8673. <documentation>
  8674. PayerInfoType
  8675. Payer information
  8676. </documentation>
  8677. </annotation>
  8678. <sequence>
  8679. <element name="Payer" type="ns:EmailAddressType" minOccurs="0">
  8680. <annotation>
  8681. <documentation>
  8682. Email address of payer
  8683. <br/>Character length and limitations: 127 single-byte characters
  8684. </documentation>
  8685. </annotation>
  8686. </element>
  8687. <element name="PayerID" type="ns:UserIDType" minOccurs="0">
  8688. <annotation>
  8689. <documentation>
  8690. Unique customer ID
  8691. <br/>Character length and limitations: 17 single-byte characters
  8692. </documentation>
  8693. </annotation>
  8694. </element>
  8695. <element name="PayerStatus" type="ns:PayPalUserStatusCodeType" minOccurs="0">
  8696. <annotation>
  8697. <documentation>
  8698. Status of payer's email address
  8699. </documentation>
  8700. </annotation>
  8701. </element>
  8702. <element name="PayerName" type="ns:PersonNameType">
  8703. <annotation>
  8704. <documentation>
  8705. Name of payer </documentation>
  8706. </annotation>
  8707. </element>
  8708. <element name="PayerCountry" type="ns:CountryCodeType" minOccurs="0">
  8709. <annotation>
  8710. <documentation>
  8711. Payment sender's country of residence using standard two-character ISO 3166 country codes.
  8712. Character length and limitations: Two single-byte characters
  8713. </documentation>
  8714. </annotation>
  8715. </element>
  8716. <element name="PayerBusiness" type="xs:string" minOccurs="0">
  8717. <annotation>
  8718. <documentation>
  8719. Payer's business name.
  8720. <br/>Character length and limitations: 127 single-byte characters</documentation>
  8721. </annotation>
  8722. </element>
  8723. <element name="Address" type="ns:AddressType" minOccurs="0">
  8724. <annotation>
  8725. <documentation>
  8726. Payer's business address</documentation>
  8727. </annotation>
  8728. </element>
  8729. <element name="ContactPhone" type="xs:string" minOccurs="0">
  8730. <annotation>
  8731. <documentation>Business contact telephone number</documentation>
  8732. </annotation>
  8733. </element>
  8734. <element name="TaxIdDetails" type="ns:TaxIdDetailsType" minOccurs="0" maxOccurs="1">
  8735. <annotation>
  8736. <documentation>
  8737. Details about payer's tax info.<br/>
  8738. Refer to the TaxIdDetailsType for more details.<br/>
  8739. </documentation>
  8740. </annotation>
  8741. </element>
  8742. <element name="EnhancedPayerInfo" type="ed:EnhancedPayerInfoType" minOccurs="0" maxOccurs="1">
  8743. <annotation>
  8744. <documentation>Holds any enhanced information about the payer</documentation>
  8745. </annotation>
  8746. </element>
  8747. </sequence>
  8748. </complexType>
  8749. <complexType name="InstrumentDetailsType">
  8750. <annotation>
  8751. <documentation>
  8752. InstrumentDetailsType
  8753. Promotional Instrument Information.
  8754. </documentation>
  8755. </annotation>
  8756. <sequence>
  8757. <element name="InstrumentCategory" type="xs:string" minOccurs="0">
  8758. <annotation>
  8759. <documentation>
  8760. This field holds the category of the instrument only when it is promotional. Return value 1 represents BML.
  8761. </documentation>
  8762. </annotation>
  8763. </element>
  8764. </sequence>
  8765. </complexType>
  8766. <complexType name="BMLOfferInfoType">
  8767. <annotation>
  8768. <documentation>
  8769. BMLOfferInfoType
  8770. Specific information for BML.
  8771. </documentation>
  8772. </annotation>
  8773. <sequence>
  8774. <element name="OfferTrackingID" type="xs:string" minOccurs="0">
  8775. <annotation>
  8776. <documentation>
  8777. Unique identification for merchant/buyer/offer combo.
  8778. </documentation>
  8779. </annotation>
  8780. </element>
  8781. </sequence>
  8782. </complexType>
  8783. <complexType name="OfferDetailsType">
  8784. <annotation>
  8785. <documentation>
  8786. OfferDetailsType
  8787. Specific information for an offer.
  8788. </documentation>
  8789. </annotation>
  8790. <sequence>
  8791. <element name="OfferCode" type="xs:string" minOccurs="0">
  8792. <annotation>
  8793. <documentation>
  8794. Code used to identify the promotion offer.
  8795. </documentation>
  8796. </annotation>
  8797. </element>
  8798. <element name="BMLOfferInfo" type="ns:BMLOfferInfoType" minOccurs="0">
  8799. <annotation>
  8800. <documentation>
  8801. Specific infromation for BML, Similar structure could be added for sepcific
  8802. <br/> promotion needs like CrossPromotions
  8803. </documentation>
  8804. </annotation>
  8805. </element>
  8806. </sequence>
  8807. </complexType>
  8808. <complexType name="PaymentInfoType">
  8809. <annotation>
  8810. <documentation>
  8811. PaymentInfoType
  8812. Payment information.
  8813. </documentation>
  8814. </annotation>
  8815. <sequence>
  8816. <element ref="ns:TransactionID">
  8817. <annotation>
  8818. <documentation>A transaction identification number.
  8819. <br/>Character length and limits: 19 single-byte characters maximum
  8820. </documentation>
  8821. </annotation>
  8822. </element>
  8823. <element ref="ns:EbayTransactionID" minOccurs="0">
  8824. <annotation>
  8825. <documentation>Its Ebay transaction id.
  8826. <br/>EbayTransactionID will returned for immediate pay item transaction in ECA
  8827. </documentation>
  8828. </annotation>
  8829. </element>
  8830. <element name="ParentTransactionID" type="ns:TransactionId" minOccurs="0">
  8831. <annotation>
  8832. <documentation>
  8833. Parent or related transaction identification number. This field is populated for the following transaction types:
  8834. <br/>
  8835. <br/>
  8836. Reversal
  8837. <br/>
  8838. Capture of an authorized transaction.
  8839. <br/>
  8840. Reauthorization of a transaction.
  8841. <br/>
  8842. Capture of an order. The value of ParentTransactionID is the original OrderID.
  8843. <br/>
  8844. Authorization of an order. The value of ParentTransactionID is the original OrderID.
  8845. <br/>
  8846. Capture of an order authorization.
  8847. <br/>
  8848. Void of an order. The value of ParentTransactionID is the original OrderID.
  8849. <br/>
  8850. <br/>
  8851. Character length and limits: 19 single-byte characters maximum</documentation>
  8852. </annotation>
  8853. </element>
  8854. <element ref="ns:ReceiptID" minOccurs="0">
  8855. <annotation>
  8856. <documentation>
  8857. Receipt ID
  8858. <br/>
  8859. <br/>
  8860. Character length and limitations: 16 digits in xxxx-xxxx-xxxx-xxxx format</documentation>
  8861. </annotation>
  8862. </element>
  8863. <element name="TransactionType" type="ns:PaymentTransactionCodeType">
  8864. <annotation>
  8865. <documentation>
  8866. The type of transaction
  8867. <br/>
  8868. <br/>
  8869. cart: Transaction created via the PayPal Shopping Cart feature or by Express Checkout with multiple purchased item
  8870. <br/>
  8871. <br/>
  8872. express-checkout: Transaction created by Express Checkout with a single purchased items
  8873. <br/>
  8874. <br/>
  8875. send-money: Transaction created by customer from the Send Money tab on the PayPal website.
  8876. <br/>
  8877. <br/>
  8878. web-accept: Transaction created by customer via Buy Now, Donation, or Auction Smart Logos.
  8879. <br/>
  8880. <br/>
  8881. subscr-*: Transaction created by customer via Subscription. eot means "end of subscription term."
  8882. <br/>
  8883. <br/>
  8884. merch-pmt: preapproved payment.
  8885. <br/>
  8886. <br/>
  8887. mass-pay: Transaction created via MassPay.
  8888. <br/>
  8889. <br/>
  8890. virtual-terminal: Transaction created via merchant virtual terminal.
  8891. <br/>
  8892. <br/>
  8893. credit: Transaction created via merchant virtual terminal or API to credit a customer.
  8894. </documentation>
  8895. </annotation>
  8896. </element>
  8897. <element name="PaymentType" type="ns:PaymentCodeType" minOccurs="0">
  8898. <annotation>
  8899. <documentation>
  8900. The type of payment</documentation>
  8901. </annotation>
  8902. </element>
  8903. <element name="RefundSourceCodeType" type="ns:RefundSourceCodeType" minOccurs="0">
  8904. <annotation>
  8905. <documentation>
  8906. The type of funding source</documentation>
  8907. </annotation>
  8908. </element>
  8909. <element name="ExpectedeCheckClearDate" type="xs:dateTime">
  8910. <annotation>
  8911. <documentation>
  8912. eCheck latest expected clear date </documentation>
  8913. </annotation>
  8914. </element>
  8915. <element name="PaymentDate" type="xs:dateTime">
  8916. <annotation>
  8917. <documentation>
  8918. Date and time of payment </documentation>
  8919. </annotation>
  8920. </element>
  8921. <element name="GrossAmount" type="cc:BasicAmountType">
  8922. <annotation>
  8923. <documentation>
  8924. Full amount of the customer's payment, before transaction fee is subtracted</documentation>
  8925. </annotation>
  8926. </element>
  8927. <element name="FeeAmount" type="cc:BasicAmountType" minOccurs="0">
  8928. <annotation>
  8929. <documentation>
  8930. Transaction fee associated with the payment </documentation>
  8931. </annotation>
  8932. </element>
  8933. <element name="SettleAmount" type="cc:BasicAmountType" minOccurs="0">
  8934. <annotation>
  8935. <documentation>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. </documentation>
  8936. </annotation>
  8937. </element>
  8938. <element name="TaxAmount" type="cc:BasicAmountType" minOccurs="0">
  8939. <annotation>
  8940. <documentation>
  8941. Amount of tax for transaction </documentation>
  8942. </annotation>
  8943. </element>
  8944. <element name="ExchangeRate" type="xs:string" minOccurs="0">
  8945. <annotation>
  8946. <documentation>
  8947. Exchange rate for transaction </documentation>
  8948. </annotation>
  8949. </element>
  8950. <element name="PaymentStatus" type="ns:PaymentStatusCodeType">
  8951. <annotation>
  8952. <documentation>
  8953. The status of the payment:
  8954. <br/>
  8955. <br/>
  8956. None: No status
  8957. <br/>
  8958. <br/>
  8959. Created: A giropay payment has been initiated.
  8960. <br/>
  8961. <br/>
  8962. 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.
  8963. <br/>
  8964. <br/>
  8965. Completed: The payment has been completed, and the funds have been added successfully to your account balance.
  8966. <br/>
  8967. <br/>
  8968. Denied: You denied the payment. This happens only if the payment was previously pending because of possible reasons described for the PendingReason element.
  8969. <br/>
  8970. <br/>
  8971. Expired: This authorization has expired and cannot be captured.
  8972. <br/>
  8973. <br/>
  8974. Failed: The payment has failed. This happens only if the payment was made from your customer's bank account.
  8975. <br/>
  8976. <br/>
  8977. In-Progress: The transaction is in process of authorization and capture.
  8978. <br/>
  8979. <br/>
  8980. Partially-Refunded: The transaction has been partially refunded.
  8981. <br/>
  8982. <br/>
  8983. Pending: The payment is pending. See "PendingReason" for more information.
  8984. <br/>
  8985. <br/>
  8986. Refunded: You refunded the payment.
  8987. <br/>
  8988. <br/>
  8989. 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.
  8990. <br/>
  8991. <br/>
  8992. Processed: A payment has been accepted.
  8993. <br/>
  8994. <br/>
  8995. Voided: This authorization has been voided.
  8996. <br/>
  8997. <br/>
  8998. 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.
  8999. </documentation>
  9000. </annotation>
  9001. </element>
  9002. <element name="PendingReason" type="ns:PendingStatusCodeType" minOccurs="0">
  9003. <annotation>
  9004. <documentation>
  9005. The reason the payment is pending:
  9006. none: No pending reason
  9007. <br/>
  9008. <br/>
  9009. 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.
  9010. <br/>
  9011. <br/>
  9012. authorization: You set PaymentAction to Authorization on SetExpressCheckoutRequest and have not yet captured funds.
  9013. <br/>
  9014. <br/>
  9015. echeck: The payment is pending because it was made by an eCheck that has not yet cleared.
  9016. <br/>
  9017. <br/>
  9018. 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.
  9019. <br/>
  9020. <br/>
  9021. 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.
  9022. <br/>
  9023. <br/>
  9024. unilateral: The payment is pending because it was made to an email address that is not yet registered or confirmed.
  9025. <br/>
  9026. <br/>
  9027. 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.
  9028. <br/>
  9029. <br/>
  9030. verify: The payment is pending because you are not yet verified. You must verify your account before you can accept this payment.
  9031. <br/>
  9032. <br/>
  9033. other: The payment is pending for a reason other than those listed above. For more information, contact PayPal Customer Service.
  9034. </documentation>
  9035. </annotation>
  9036. </element>
  9037. <element name="ReasonCode" type="ns:ReversalReasonCodeType" minOccurs="0">
  9038. <annotation>
  9039. <documentation>
  9040. The reason for a reversal if TransactionType is reversal:
  9041. none: No reason code
  9042. <br/>
  9043. <br/>
  9044. chargeback: A reversal has occurred on this transaction due to a chargeback by your customer.
  9045. <br/>
  9046. <br/>
  9047. guarantee: A reversal has occurred on this transaction due to your customer triggering a money-back guarantee.
  9048. <br/>
  9049. <br/>
  9050. buyer-complaint: A reversal has occurred on this transaction due to a complaint about the transaction from your customer.
  9051. <br/>
  9052. <br/>
  9053. refund: A reversal has occurred on this transaction because you have given the customer a refund.
  9054. <br/>
  9055. <br/>
  9056. other: A reversal has occurred on this transaction due to a reason not listed above.
  9057. </documentation>
  9058. </annotation>
  9059. </element>
  9060. <element name="HoldDecision" type="xs:string" minOccurs="0">
  9061. <annotation>
  9062. <documentation>
  9063. HoldDecision is returned in the response only if PaymentStatus is Completed-Funds-Held. The reason the funds are kept in pending balance:
  9064. newsellerpaymenthold: The seller is new.
  9065. <br/>
  9066. <br/>
  9067. paymenthold: A hold is placed on your transaction due to a reason not listed above.
  9068. </documentation>
  9069. </annotation>
  9070. </element>
  9071. <element name="ShippingMethod" type="xs:string" minOccurs="0">
  9072. <annotation>
  9073. <documentation>
  9074. Shipping method selected by the user during check-out.
  9075. </documentation>
  9076. </annotation>
  9077. </element>
  9078. <element name="ProtectionEligibility" type="xs:string" minOccurs="0">
  9079. <annotation>
  9080. <documentation>
  9081. Protection Eligibility for this Transaction - None, SPP or ESPP
  9082. </documentation>
  9083. </annotation>
  9084. </element>
  9085. <element name="ProtectionEligibilityType" type="xs:string" minOccurs="0">
  9086. <annotation>
  9087. <documentation>
  9088. Protection Eligibility details for this Transaction
  9089. </documentation>
  9090. </annotation>
  9091. </element>
  9092. <element name="ShipAmount" type="xs:string" minOccurs="0">
  9093. <annotation>
  9094. <documentation>
  9095. Amount of shipping charged on transaction</documentation>
  9096. </annotation>
  9097. </element>
  9098. <element name="ShipHandleAmount" type="xs:string" minOccurs="0">
  9099. <annotation>
  9100. <documentation>
  9101. Amount of ship handling charged on transaction</documentation>
  9102. </annotation>
  9103. </element>
  9104. <element name="ShipDiscount" type="xs:string" minOccurs="0">
  9105. <annotation>
  9106. <documentation>
  9107. Amount of shipping discount on transaction</documentation>
  9108. </annotation>
  9109. </element>
  9110. <element name="InsuranceAmount" type="xs:string" minOccurs="0">
  9111. <annotation>
  9112. <documentation>
  9113. Amount of Insurance amount on transaction</documentation>
  9114. </annotation>
  9115. </element>
  9116. <element name="Subject" type="xs:string" minOccurs="0">
  9117. <annotation>
  9118. <documentation>
  9119. Subject as entered in the transaction</documentation>
  9120. </annotation>
  9121. </element>
  9122. <element name="SellerDetails" type="ns:SellerDetailsType" minOccurs="0" maxOccurs="1">
  9123. <annotation>
  9124. <documentation>
  9125. Details about the seller.<br/>
  9126. Optional <br/>
  9127. </documentation>
  9128. </annotation>
  9129. </element>
  9130. <element name="PaymentRequestID" type="xs:string" minOccurs="0">
  9131. <annotation>
  9132. <documentation>
  9133. Unique identifier and mandatory for each bucket in case of split payement
  9134. </documentation>
  9135. </annotation>
  9136. </element>
  9137. <element name="FMFDetails" type="ns:FMFDetailsType" minOccurs="0" maxOccurs="1">
  9138. <annotation>
  9139. <documentation>
  9140. Thes are filters that could result in accept/deny/pending action.
  9141. </documentation>
  9142. </annotation>
  9143. </element>
  9144. <element name="EnhancedPaymentInfo" type="ed:EnhancedPaymentInfoType" minOccurs="0" maxOccurs="1">
  9145. <annotation>
  9146. <documentation>
  9147. This will be enhanced info for the payment: Example: UATP details
  9148. </documentation>
  9149. </annotation>
  9150. </element>
  9151. <element name="PaymentError" type="ns:ErrorType" minOccurs="0" maxOccurs="1">
  9152. <annotation>
  9153. <documentation>
  9154. This will indicate the payment status for individual payment request in case of split payment
  9155. </documentation>
  9156. </annotation>
  9157. </element>
  9158. <element name="InstrumentDetails" type="ns:InstrumentDetailsType" minOccurs="0">
  9159. <annotation>
  9160. <documentation>
  9161. Type of the payment instrument.
  9162. </documentation>
  9163. </annotation>
  9164. </element>
  9165. <element name="OfferDetails" type="ns:OfferDetailsType" minOccurs="0">
  9166. <annotation>
  9167. <documentation>
  9168. Offer Details.
  9169. </documentation>
  9170. </annotation>
  9171. </element>
  9172. </sequence>
  9173. </complexType>
  9174. <complexType name="SubscriptionTermsType">
  9175. <annotation>
  9176. <documentation>
  9177. SubscriptionTermsType
  9178. Terms of a PayPal subscription.
  9179. </documentation>
  9180. </annotation>
  9181. <sequence>
  9182. <element name="Amount" type="cc:BasicAmountType"/>
  9183. </sequence>
  9184. <attribute name="period" type="xs:string" use="required"/>
  9185. </complexType>
  9186. <complexType name="SubscriptionInfoType">
  9187. <annotation>
  9188. <documentation>
  9189. SubscriptionInfoType
  9190. Information about a PayPal Subscription.
  9191. </documentation>
  9192. </annotation>
  9193. <sequence>
  9194. <element ref="ns:SubscriptionID">
  9195. <annotation>
  9196. <documentation>
  9197. ID generated by PayPal for the subscriber.
  9198. Character length and limitations: no limit</documentation>
  9199. </annotation>
  9200. </element>
  9201. <element name="SubscriptionDate" type="xs:dateTime" minOccurs="0">
  9202. <annotation>
  9203. <documentation>
  9204. Subscription start date </documentation>
  9205. </annotation>
  9206. </element>
  9207. <element name="EffectiveDate" type="xs:dateTime" minOccurs="0">
  9208. <annotation>
  9209. <documentation>
  9210. Date when the subscription modification will be effective </documentation>
  9211. </annotation>
  9212. </element>
  9213. <element name="RetryTime" type="xs:dateTime" minOccurs="0">
  9214. <annotation>
  9215. <documentation>
  9216. Date PayPal will retry a failed subscription payment </documentation>
  9217. </annotation>
  9218. </element>
  9219. <element name="Username" type="xs:string" minOccurs="0">
  9220. <annotation>
  9221. <documentation>
  9222. Username generated by PayPal and given to subscriber to access the subscription.
  9223. Character length and limitations: 64 alphanumeric single-byte characters</documentation>
  9224. </annotation>
  9225. </element>
  9226. <element name="Password" type="xs:string" minOccurs="0">
  9227. <annotation>
  9228. <documentation>
  9229. Password generated by PayPal and given to subscriber to access the subscription. For security, the value of the password is hashed.
  9230. Character length and limitations: 128 alphanumeric single-byte characters</documentation>
  9231. </annotation>
  9232. </element>
  9233. <element name="Recurrences" type="xs:string" minOccurs="0">
  9234. <annotation>
  9235. <documentation>
  9236. The number of payment installments that will occur at the regular rate.
  9237. Character length and limitations: no limit</documentation>
  9238. </annotation>
  9239. </element>
  9240. <element name="Terms" type="ns:SubscriptionTermsType" minOccurs="0" maxOccurs="unbounded">
  9241. <annotation>
  9242. <documentation>
  9243. Subscription duration and charges</documentation>
  9244. </annotation>
  9245. </element>
  9246. </sequence>
  9247. <attribute name="reattempt" type="xs:string" use="required"/>
  9248. <attribute name="recurring" type="xs:string" use="required"/>
  9249. </complexType>
  9250. <complexType name="AuctionInfoType">
  9251. <annotation>
  9252. <documentation>
  9253. AuctionInfoType
  9254. Basic information about an auction.
  9255. </documentation>
  9256. </annotation>
  9257. <sequence>
  9258. <element name="BuyerID" type="xs:string" minOccurs="0">
  9259. <annotation>
  9260. <documentation>
  9261. Customer's auction ID </documentation>
  9262. </annotation>
  9263. </element>
  9264. <element name="ClosingDate" type="xs:dateTime" minOccurs="0">
  9265. <annotation>
  9266. <documentation>
  9267. Auction's close date </documentation>
  9268. </annotation>
  9269. </element>
  9270. </sequence>
  9271. <attribute name="multiItem" type="xs:string" use="required"/>
  9272. </complexType>
  9273. <complexType name="OptionType">
  9274. <annotation>
  9275. <documentation>
  9276. OptionType
  9277. PayPal item options for shopping cart.
  9278. </documentation>
  9279. <!-- add more documentation here -->
  9280. </annotation>
  9281. <sequence/>
  9282. <attribute name="name" type="xs:string" use="required"/>
  9283. <attribute name="value" type="xs:string" use="required"/>
  9284. </complexType>
  9285. <complexType name="EbayItemPaymentDetailsItemType">
  9286. <annotation>
  9287. <documentation>
  9288. EbayItemPaymentDetailsItemType - Type declaration to be used by other schemas.
  9289. Information about an Ebay Payment Item.
  9290. </documentation>
  9291. <!-- add more documentation here -->
  9292. </annotation>
  9293. <sequence>
  9294. <element name="ItemNumber" type="xs:string" minOccurs="0">
  9295. <annotation>
  9296. <documentation>
  9297. Auction ItemNumber.
  9298. <br/>
  9299. <br/>
  9300. Optional
  9301. <br/>
  9302. <br/>
  9303. Character length and limitations: 765 single-byte characters
  9304. </documentation>
  9305. </annotation>
  9306. </element>
  9307. <element name="AuctionTransactionId" type="xs:string" minOccurs="0">
  9308. <annotation>
  9309. <documentation>
  9310. Auction Transaction ID.
  9311. <br/>
  9312. <br/>
  9313. Optional
  9314. <br/>
  9315. <br/>
  9316. Character length and limitations: 255 single-byte characters
  9317. </documentation>
  9318. </annotation>
  9319. </element>
  9320. <element name="OrderId" type="xs:string" minOccurs="0">
  9321. <annotation>
  9322. <documentation>
  9323. Ebay Order ID.
  9324. <br/>
  9325. <br/>
  9326. Optional
  9327. <br/>
  9328. <br/>
  9329. Character length and limitations: 64 single-byte characters
  9330. </documentation>
  9331. </annotation>
  9332. </element>
  9333. <element name="CartID" type="xs:string" minOccurs="0">
  9334. <annotation>
  9335. <documentation>
  9336. Ebay Cart ID.
  9337. <br/>
  9338. <br/>
  9339. Optional
  9340. <br/>
  9341. <br/>
  9342. Character length and limitations: 64 single-byte characters
  9343. </documentation>
  9344. </annotation>
  9345. </element>
  9346. </sequence>
  9347. </complexType>
  9348. <complexType name="PaymentDetailsItemType">
  9349. <annotation>
  9350. <documentation>
  9351. PaymentDetailsItemType
  9352. Information about a Payment Item.
  9353. </documentation>
  9354. <!-- add more documentation here -->
  9355. </annotation>
  9356. <sequence>
  9357. <element name="Name" type="xs:string" minOccurs="0">
  9358. <annotation>
  9359. <documentation>
  9360. Item name.
  9361. <br/>
  9362. <br/>
  9363. Optional
  9364. <br/>
  9365. <br/>
  9366. Character length and limitations: 127 single-byte characters
  9367. </documentation>
  9368. </annotation>
  9369. </element>
  9370. <element name="Number" type="xs:string" minOccurs="0">
  9371. <annotation>
  9372. <documentation>
  9373. Item number.
  9374. <br/>
  9375. <br/>
  9376. Optional
  9377. <br/>
  9378. <br/>
  9379. Character length and limitations: 127 single-byte characters
  9380. </documentation>
  9381. </annotation>
  9382. </element>
  9383. <element name="Quantity" type="xs:integer" minOccurs="0">
  9384. <annotation>
  9385. <documentation>
  9386. Item quantity.
  9387. <br/>
  9388. <br/>
  9389. Optional
  9390. <br/>
  9391. <br/>
  9392. Character length and limitations: Any positive integer</documentation>
  9393. </annotation>
  9394. </element>
  9395. <element name="Tax" type="cc:BasicAmountType" minOccurs="0">
  9396. <annotation>
  9397. <documentation>
  9398. Item sales tax.
  9399. <br/>
  9400. <br/>
  9401. Optional
  9402. <br/>
  9403. <br/>Character length and limitations: any valid currency amount; currency code is set the same as for OrderTotal.
  9404. </documentation>
  9405. </annotation>
  9406. </element>
  9407. <element name="Amount" type="cc:BasicAmountType" minOccurs="0">
  9408. <annotation>
  9409. <documentation>
  9410. Cost of item
  9411. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.
  9412. <br/>
  9413. <br/>
  9414. Optional
  9415. <br/>
  9416. <br/>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 (,).
  9417. </documentation>
  9418. </annotation>
  9419. </element>
  9420. <element name="EbayItemPaymentDetailsItem" type="ns:EbayItemPaymentDetailsItemType" minOccurs="0">
  9421. <annotation>
  9422. <documentation>
  9423. Ebay specific details.
  9424. <br/>
  9425. <br/>
  9426. Optional
  9427. <br/>
  9428. </documentation>
  9429. </annotation>
  9430. </element>
  9431. <element name="PromoCode" type="xs:string" minOccurs="0" maxOccurs="1">
  9432. <annotation>
  9433. <documentation>
  9434. Promotional financing code for item. Part of the Merchant Services Promotion Financing feature.
  9435. </documentation>
  9436. </annotation>
  9437. </element>
  9438. <element name="ProductCategory" type="ns:ProductCategoryType" minOccurs="0" maxOccurs="1">
  9439. <annotation>
  9440. <documentation>
  9441. </documentation>
  9442. </annotation>
  9443. </element>
  9444. <element name="Description" type="xs:string" minOccurs="0" maxOccurs="1">
  9445. <annotation>
  9446. <documentation>
  9447. Item description. <br/>
  9448. Optional<br/>
  9449. Character length and limitations: 127 single-byte characters
  9450. </documentation>
  9451. </annotation>
  9452. </element>
  9453. <element name="ItemWeight" type="cc:MeasureType" minOccurs="0" maxOccurs="1">
  9454. <annotation>
  9455. <documentation>
  9456. Information about the Item weight.
  9457. </documentation>
  9458. </annotation>
  9459. </element>
  9460. <element name="ItemLength" type="cc:MeasureType" minOccurs="0" maxOccurs="1">
  9461. <annotation>
  9462. <documentation>
  9463. Information about the Item length.
  9464. </documentation>
  9465. </annotation>
  9466. </element>
  9467. <element name="ItemWidth" type="cc:MeasureType" minOccurs="0" maxOccurs="1">
  9468. <annotation>
  9469. <documentation>
  9470. Information about the Item width.
  9471. </documentation>
  9472. </annotation>
  9473. </element>
  9474. <element name="ItemHeight" type="cc:MeasureType" minOccurs="0" maxOccurs="1">
  9475. <annotation>
  9476. <documentation>
  9477. Information about the Item height.
  9478. </documentation>
  9479. </annotation>
  9480. </element>
  9481. <element name="ItemURL" type="xs:string" minOccurs="0" maxOccurs="1">
  9482. <annotation>
  9483. <documentation>
  9484. URL for the item.<br/>
  9485. Optional<br/>
  9486. Character length and limitations: no limit.
  9487. </documentation>
  9488. </annotation>
  9489. </element>
  9490. <element name="EnhancedItemData" type="ed:EnhancedItemDataType" minOccurs="0" maxOccurs="1">
  9491. <annotation>
  9492. <documentation>
  9493. Enhanced data for each item in the cart.<br/>
  9494. Optional<br/>
  9495. </documentation>
  9496. </annotation>
  9497. </element>
  9498. <element name="ItemCategory" type="ns:ItemCategoryType" minOccurs="0" maxOccurs="1">
  9499. <annotation>
  9500. <documentation>
  9501. Item category - physical or digital. <br/>
  9502. Optional<br/>
  9503. </documentation>
  9504. </annotation>
  9505. </element>
  9506. </sequence>
  9507. </complexType>
  9508. <complexType name="PaymentItemType">
  9509. <annotation>
  9510. <documentation>
  9511. PaymentItemType
  9512. Information about a Payment Item.
  9513. </documentation>
  9514. </annotation>
  9515. <sequence>
  9516. <element name="EbayItemTxnId" type="xs:string" minOccurs="0" >
  9517. <annotation>
  9518. <documentation>
  9519. eBay Auction Transaction ID of the Item
  9520. <br/>Optional<br/>
  9521. <br/>Character length and limitations: 255 single-byte characters
  9522. </documentation>
  9523. </annotation>
  9524. </element>
  9525. <element name="Name" type="xs:string" minOccurs="0">
  9526. <annotation>
  9527. <documentation>
  9528. Item name set by you or entered by the customer.
  9529. <br/>Character length and limitations: 127 single-byte alphanumeric characters
  9530. </documentation>
  9531. </annotation>
  9532. </element>
  9533. <element name="Number" type="xs:string" minOccurs="0">
  9534. <annotation>
  9535. <documentation>
  9536. Item number set by you.
  9537. <br/>
  9538. Character length and limitations: 127 single-byte alphanumeric characters</documentation>
  9539. </annotation>
  9540. </element>
  9541. <element name="Quantity" type="xs:string" minOccurs="0">
  9542. <annotation>
  9543. <documentation>
  9544. Quantity set by you or entered by the customer.
  9545. <br/>
  9546. Character length and limitations: no limit</documentation>
  9547. </annotation>
  9548. </element>
  9549. <element name="SalesTax" type="xs:string" minOccurs="0">
  9550. <annotation>
  9551. <documentation>
  9552. Amount of tax charged on payment </documentation>
  9553. </annotation>
  9554. </element>
  9555. <element name="ShippingAmount" type="xs:string" minOccurs="0">
  9556. <annotation>
  9557. <documentation>
  9558. Amount of shipping charged on payment </documentation>
  9559. </annotation>
  9560. </element>
  9561. <element name="HandlingAmount" type="xs:string" minOccurs="0">
  9562. <annotation>
  9563. <documentation>
  9564. Amount of handling charged on payment </documentation>
  9565. </annotation>
  9566. </element>
  9567. <element name="Amount" type="cc:BasicAmountType" minOccurs="0">
  9568. <annotation>
  9569. <documentation>
  9570. Cost of item </documentation>
  9571. </annotation>
  9572. </element>
  9573. <element name="Options" type="ns:OptionType" minOccurs="0" maxOccurs="unbounded">
  9574. <annotation>
  9575. <documentation>
  9576. Item options selected in PayPal shopping cart </documentation>
  9577. </annotation>
  9578. </element>
  9579. </sequence>
  9580. </complexType>
  9581. <complexType name="PaymentItemInfoType">
  9582. <annotation>
  9583. <documentation>
  9584. PaymentItemInfoType
  9585. Information about a PayPal item.
  9586. </documentation>
  9587. </annotation>
  9588. <sequence>
  9589. <element name="InvoiceID" type="xs:string" minOccurs="0">
  9590. <annotation>
  9591. <documentation>
  9592. Invoice number you set in the original transaction.
  9593. <br/>
  9594. <br/>
  9595. Character length and limitations: 127 single-byte alphanumeric characters </documentation>
  9596. </annotation>
  9597. </element>
  9598. <element name="Custom" type="xs:string" minOccurs="0">
  9599. <annotation>
  9600. <documentation>
  9601. Custom field you set in the original transaction.
  9602. <br/>
  9603. <br/>
  9604. Character length and limitations: 127 single-byte alphanumeric characters</documentation>
  9605. </annotation>
  9606. </element>
  9607. <element name="Memo" type="xs:string" minOccurs="0">
  9608. <annotation>
  9609. <documentation>
  9610. Memo entered by your customer in PayPal Website Payments note field.
  9611. <br/>
  9612. <br/>
  9613. Character length and limitations: 255 single-byte alphanumeric characters</documentation>
  9614. </annotation>
  9615. </element>
  9616. <element name="SalesTax" type="xs:string" minOccurs="0">
  9617. <annotation>
  9618. <documentation>
  9619. Amount of tax charged on transaction</documentation>
  9620. </annotation>
  9621. </element>
  9622. <element name="PaymentItem" type="ns:PaymentItemType" minOccurs="0" maxOccurs="unbounded">
  9623. <annotation>
  9624. <documentation>
  9625. Details about the indivudal purchased item</documentation>
  9626. </annotation>
  9627. </element>
  9628. <element name="Subscription" type="ns:SubscriptionInfoType" minOccurs="0">
  9629. <annotation>
  9630. <documentation>
  9631. Information about the transaction if it was created via PayPal Subcriptions</documentation>
  9632. </annotation>
  9633. </element>
  9634. <element name="Auction" type="ns:AuctionInfoType" minOccurs="0">
  9635. <annotation>
  9636. <documentation>
  9637. Information about the transaction if it was created via an auction</documentation>
  9638. </annotation>
  9639. </element>
  9640. </sequence>
  9641. </complexType>
  9642. <complexType name="PaymentDetailsType">
  9643. <annotation>
  9644. <documentation>
  9645. PaymentDetailsType
  9646. Information about a payment. Used by DCC and Express Checkout.
  9647. </documentation>
  9648. </annotation>
  9649. <sequence>
  9650. <element name="OrderTotal" type="cc:BasicAmountType" minOccurs="0">
  9651. <annotation>
  9652. <documentation>
  9653. Total of order, including shipping, handling, and tax.
  9654. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.
  9655. <br/>
  9656. <br/>
  9657. <br/>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 (,). </documentation>
  9658. </annotation>
  9659. </element>
  9660. <element name="ItemTotal" type="cc:BasicAmountType" minOccurs="0">
  9661. <annotation>
  9662. <documentation>
  9663. Sum of cost of all items in this order.
  9664. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.
  9665. <br/>
  9666. <br/>
  9667. Optional
  9668. <br/>
  9669. <br/>separator must be a comma (,).
  9670. </documentation>
  9671. </annotation>
  9672. </element>
  9673. <element name="ShippingTotal" type="cc:BasicAmountType" minOccurs="0">
  9674. <annotation>
  9675. <documentation>
  9676. Total shipping costs for this order.
  9677. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.
  9678. <br/>
  9679. <br/>
  9680. Optional
  9681. <br/>
  9682. <br/>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 (,).
  9683. </documentation>
  9684. </annotation>
  9685. </element>
  9686. <element name="HandlingTotal" type="cc:BasicAmountType" minOccurs="0">
  9687. <annotation>
  9688. <documentation>
  9689. Total handling costs for this order.
  9690. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.
  9691. <br/>
  9692. <br/>
  9693. Optional
  9694. <br/>
  9695. <br/>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 (,).
  9696. </documentation>
  9697. </annotation>
  9698. </element>
  9699. <element name="TaxTotal" type="cc:BasicAmountType" minOccurs="0">
  9700. <annotation>
  9701. <documentation>
  9702. Sum of tax for all items in this order.
  9703. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.
  9704. <br/>
  9705. <br/>
  9706. Optional
  9707. <br/>
  9708. <br/>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 (,).
  9709. </documentation>
  9710. </annotation>
  9711. </element>
  9712. <element name="OrderDescription" type="xs:string" minOccurs="0">
  9713. <annotation>
  9714. <documentation>
  9715. Description of items the customer is purchasing.
  9716. <br/>
  9717. <br/>
  9718. Optional
  9719. <br/>
  9720. <br/>Character length and limitations: 127 single-byte alphanumeric characters
  9721. </documentation>
  9722. </annotation>
  9723. </element>
  9724. <element name="Custom" type="xs:string" minOccurs="0">
  9725. <annotation>
  9726. <documentation>
  9727. A free-form field for your own use.
  9728. <br/>
  9729. <br/>
  9730. Optional
  9731. <br/>
  9732. <br/>Character length and limitations: 256 single-byte alphanumeric characters
  9733. </documentation>
  9734. </annotation>
  9735. </element>
  9736. <element name="InvoiceID" type="xs:string" minOccurs="0">
  9737. <annotation>
  9738. <documentation>
  9739. Your own invoice or tracking number.
  9740. <br/>
  9741. <br/>
  9742. Optional
  9743. <br/>
  9744. <br/>Character length and limitations: 127 single-byte alphanumeric characters
  9745. </documentation>
  9746. </annotation>
  9747. </element>
  9748. <element name="ButtonSource" type="xs:string" minOccurs="0">
  9749. <annotation>
  9750. <documentation>
  9751. An identification code for use by third-party applications to identify transactions.
  9752. <br/>
  9753. <br/>
  9754. Optional
  9755. <br/>
  9756. <br/>Character length and limitations: 32 single-byte alphanumeric characters
  9757. </documentation>
  9758. </annotation>
  9759. </element>
  9760. <element name="NotifyURL" type="xs:string" minOccurs="0">
  9761. <annotation>
  9762. <documentation>
  9763. Your URL for receiving Instant Payment Notification (IPN) about this transaction.
  9764. <br/>
  9765. <br/>
  9766. Optional
  9767. <br/>
  9768. <br/>If you do not specify NotifyURL in the request, the notification URL from your Merchant Profile is used, if one exists.
  9769. <br/>
  9770. <br/>Character length and limitations: 2,048 single-byte alphanumeric characters
  9771. </documentation>
  9772. </annotation>
  9773. </element>
  9774. <element name="ShipToAddress" type="ns:AddressType" minOccurs="0">
  9775. <annotation>
  9776. <documentation>
  9777. Address the order will be shipped to.
  9778. <br/>
  9779. <br/>
  9780. Optional
  9781. <br/>
  9782. <br/>
  9783. If you include the ShipToAddress element, the AddressType elements are required:
  9784. <br/>
  9785. <br/>Name
  9786. <br/>
  9787. <br/>
  9788. Street1
  9789. <br/>
  9790. <br/>
  9791. CityName
  9792. <br/>
  9793. <br/>
  9794. CountryCode
  9795. <br/>
  9796. <br/>
  9797. <b>Do not set set the CountryName element.</b>
  9798. </documentation>
  9799. </annotation>
  9800. </element>
  9801. <element name="ShippingMethod" type="ns:ShippingServiceCodeType" minOccurs="0" maxOccurs="1">
  9802. <annotation>
  9803. <documentation>
  9804. </documentation>
  9805. </annotation>
  9806. </element>
  9807. <element name="ProfileAddressChangeDate" type="xs:dateTime" minOccurs="0" maxOccurs="1">
  9808. <annotation>
  9809. <documentation>
  9810. Date and time (in GMT in the format yyyy-MM-ddTHH:mm:ssZ) at which address was changed by the user.
  9811. </documentation>
  9812. </annotation>
  9813. </element>
  9814. <element name="PaymentDetailsItem" type="ns:PaymentDetailsItemType" minOccurs="0" maxOccurs="unbounded">
  9815. <annotation>
  9816. <documentation>
  9817. Information about the individual purchased items</documentation>
  9818. </annotation>
  9819. </element>
  9820. <element name="InsuranceTotal" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  9821. <annotation>
  9822. <documentation>
  9823. Total shipping insurance costs for this order.<br/>
  9824. Optional<br/>
  9825. </documentation>
  9826. </annotation>
  9827. </element>
  9828. <element name="ShippingDiscount" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  9829. <annotation>
  9830. <documentation>
  9831. Shipping discount for this order, specified as a negative number.<br/>
  9832. Optional<br/>
  9833. </documentation>
  9834. </annotation>
  9835. </element>
  9836. <element name="InsuranceOptionOffered" type="xs:string" minOccurs="0" maxOccurs="1">
  9837. <annotation>
  9838. <documentation>
  9839. Information about the Insurance options.
  9840. </documentation>
  9841. </annotation>
  9842. </element>
  9843. <element name="AllowedPaymentMethod" type="ns:AllowedPaymentMethodType" minOccurs="0" maxOccurs="1">
  9844. <annotation>
  9845. <documentation>
  9846. Allowed payment methods for this transaction.
  9847. </documentation>
  9848. </annotation>
  9849. </element>
  9850. <element name="EnhancedPaymentData" type="ed:EnhancedPaymentDataType" minOccurs="0" maxOccurs="1">
  9851. <annotation>
  9852. <documentation>
  9853. Enhanced Data section to accept channel specific data.<br/>
  9854. Optional<br/>
  9855. Refer to EnhancedPaymentDataType for details.<br/>
  9856. </documentation>
  9857. </annotation>
  9858. </element>
  9859. <element name="SellerDetails" type="ns:SellerDetailsType" minOccurs="0" maxOccurs="1">
  9860. <annotation>
  9861. <documentation>
  9862. Details about the seller.<br/>
  9863. Optional <br/>
  9864. </documentation>
  9865. </annotation>
  9866. </element>
  9867. <element name="NoteText" type="xs:string" minOccurs="0" maxOccurs="1">
  9868. <annotation>
  9869. <documentation>
  9870. Note to recipient/seller.<br/>
  9871. Optional <br/>
  9872. Character length and limitations: 127 single-byte alphanumeric characters.<br/>
  9873. </documentation>
  9874. </annotation>
  9875. </element>
  9876. <element name="TransactionId" type="xs:string" minOccurs="0" maxOccurs="1">
  9877. <annotation>
  9878. <documentation>
  9879. PayPal Transaction Id, returned once DoExpressCheckout is completed. <br/>
  9880. </documentation>
  9881. </annotation>
  9882. </element>
  9883. <element name="PaymentAction" type="ns:PaymentActionCodeType" minOccurs="0" maxOccurs="1">
  9884. <annotation>
  9885. <documentation>
  9886. How you want to obtain payment.
  9887. <br/>
  9888. <br/>
  9889. This payment action input will be used for split payments
  9890. <br/>
  9891. <br/>
  9892. Authorization indicates that this payment is a basic authorization subject to settlement with PayPal Authorization and Capture.
  9893. <br/>
  9894. <br/>
  9895. Order indicates that this payment is is an order authorization subject to settlement with PayPal Authorization and Capture.
  9896. <br/>
  9897. <br/>
  9898. Sale indicates that this is a final sale for which you are requesting payment.
  9899. <br/>
  9900. <br/>
  9901. IMPORTANT: You cannot set PaymentAction to Sale on SetExpressCheckoutRequest and then change PaymentAction to Authorization on the final Express Checkout API, DoExpressCheckoutPaymentRequest.
  9902. <br/>
  9903. <br/>
  9904. Character length and limit: Up to 13 single-byte alphabetic characters
  9905. </documentation>
  9906. </annotation>
  9907. </element>
  9908. <element name="PaymentRequestID" type="xs:string" minOccurs="0">
  9909. <annotation>
  9910. <documentation>
  9911. Unique identifier and mandatory for the particular payment request in case of multiple payment
  9912. </documentation>
  9913. </annotation>
  9914. </element>
  9915. <element name="OrderURL" type="xs:string" minOccurs="0" maxOccurs="1">
  9916. <annotation>
  9917. <documentation>
  9918. URL on Merchant site pertaining to this invoice.
  9919. <br/>
  9920. <br/>
  9921. <b>Optional</b>
  9922. <br/>
  9923. <br/>
  9924. </documentation>
  9925. </annotation>
  9926. </element>
  9927. <element name="SoftDescriptor" type="xs:string" minOccurs="0" maxOccurs="1">
  9928. <annotation>
  9929. <documentation>
  9930. Soft Descriptor supported for Sale and Auth in DEC only. For Order this will be ignored.
  9931. </documentation>
  9932. </annotation>
  9933. </element>
  9934. <element name="BranchLevel" type="xs:integer" minOccurs="0" maxOccurs="1">
  9935. <annotation>
  9936. <documentation>
  9937. BranchLevel is used to identify chain payment.
  9938. If BranchLevel is 0 or 1, this payment is where money moves to.
  9939. If BranchLevel greater than 1, this payment contains the actual seller info.
  9940. <br/>
  9941. <br/>
  9942. Optional
  9943. <br/>
  9944. </documentation>
  9945. </annotation>
  9946. </element>
  9947. <element name="OfferDetails" type="ns:OfferDetailsType" minOccurs="0" maxOccurs="1">
  9948. <annotation>
  9949. <documentation>
  9950. Soft Descriptor supported for Sale and Auth in DEC only. For Order this will be ignored.
  9951. </documentation>
  9952. </annotation>
  9953. </element>
  9954. <element name="Recurring" type="ns:RecurringFlagType" minOccurs="0" maxOccurs="1">
  9955. <annotation>
  9956. <documentation>
  9957. Flag to indicate the recurring transaction
  9958. </documentation>
  9959. </annotation>
  9960. </element>
  9961. </sequence>
  9962. </complexType>
  9963. <complexType name="IncentiveDetailsType">
  9964. <annotation>
  9965. <documentation>
  9966. Information about the incentives that were applied from Ebay RYP page and PayPal RYP page.
  9967. </documentation>
  9968. </annotation>
  9969. <sequence>
  9970. <element name="UniqueIdentifier" type="xs:string" minOccurs="0" maxOccurs="1">
  9971. <annotation>
  9972. <documentation>
  9973. Unique Identifier consisting of redemption code, user friendly descripotion, incentive type, campaign code, incenitve application order and site redeemed o
  9974. n.
  9975. </documentation>
  9976. </annotation>
  9977. </element>
  9978. <element name="SiteAppliedOn" type="ns:IncentiveSiteAppliedOnType" minOccurs="0" maxOccurs="1">
  9979. <annotation>
  9980. <documentation>
  9981. Defines if the incentive has been applied on Ebay or PayPal.
  9982. </documentation>
  9983. </annotation>
  9984. </element>
  9985. <element name="TotalDiscountAmount" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  9986. <annotation>
  9987. <documentation>
  9988. The total discount amount for the incentive, summation of discounts up across all the buckets/items.
  9989. </documentation>
  9990. </annotation>
  9991. </element>
  9992. <element name="Status" type="ns:IncentiveAppliedStatusType" minOccurs="0" maxOccurs="1">
  9993. <annotation>
  9994. <documentation>
  9995. Status of incentive processing. Sussess or Error.
  9996. </documentation>
  9997. </annotation>
  9998. </element>
  9999. <element name="ErrorCode" type="xs:integer" minOccurs="0" maxOccurs="1">
  10000. <annotation>
  10001. <documentation>
  10002. Error code if there are any errors. Zero otherwise.
  10003. </documentation>
  10004. </annotation>
  10005. </element>
  10006. <element name="IncentiveAppliedDetails" type="ns:IncentiveAppliedDetailsType" minOccurs="0" maxOccurs="unbounded">
  10007. <annotation>
  10008. <documentation>
  10009. Details of incentive application on individual bucket/item.
  10010. </documentation>
  10011. </annotation>
  10012. </element>
  10013. </sequence>
  10014. </complexType>
  10015. <complexType name="IncentiveAppliedDetailsType">
  10016. <annotation>
  10017. <documentation>
  10018. Details of incentive application on individual bucket/item.
  10019. </documentation>
  10020. </annotation>
  10021. <sequence>
  10022. <element name="PaymentRequestID" type="xs:string" minOccurs="0" maxOccurs="1">
  10023. <annotation>
  10024. <documentation>
  10025. PaymentRequestID uniquely identifies a bucket. It is the "bucket id" in the world of EC API.
  10026. </documentation>
  10027. </annotation>
  10028. </element>
  10029. <element name="ItemId" type="xs:string" minOccurs="0" maxOccurs="1">
  10030. <annotation>
  10031. <documentation>
  10032. The item id passed through by the merchant.
  10033. </documentation>
  10034. </annotation>
  10035. </element>
  10036. <element name="ExternalTxnId" type="xs:string" minOccurs="0" maxOccurs="1">
  10037. <annotation>
  10038. <documentation>
  10039. The item transaction id passed through by the merchant.
  10040. </documentation>
  10041. </annotation>
  10042. </element>
  10043. <element name="DiscountAmount" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  10044. <annotation>
  10045. <documentation>
  10046. Discount offerred for this bucket or item.
  10047. </documentation>
  10048. </annotation>
  10049. </element>
  10050. <element name="SubType" type="xs:string" minOccurs="0" >
  10051. <annotation>
  10052. <documentation>
  10053. SubType for coupon.
  10054. </documentation>
  10055. </annotation>
  10056. </element>
  10057. </sequence>
  10058. </complexType>
  10059. <complexType name="SellerDetailsType">
  10060. <annotation>
  10061. <documentation>
  10062. Details about the seller.
  10063. </documentation>
  10064. </annotation>
  10065. <sequence>
  10066. <element name="SellerId" type="xs:string" minOccurs="0" maxOccurs="1">
  10067. <annotation>
  10068. <documentation>
  10069. Unique identifier for the seller.<br/>
  10070. Optional <br/>
  10071. </documentation>
  10072. </annotation>
  10073. </element>
  10074. <element name="SellerUserName" type="xs:string" minOccurs="0" maxOccurs="1">
  10075. <annotation>
  10076. <documentation>
  10077. The user name of the user at the marketplaces site.<br/>
  10078. Optional <br/>
  10079. </documentation>
  10080. </annotation>
  10081. </element>
  10082. <element name="SellerRegistrationDate" type="xs:dateTime" minOccurs="0" maxOccurs="1">
  10083. <annotation>
  10084. <documentation>
  10085. Date when the user registered with the marketplace.<br/>
  10086. Optional <br/>
  10087. </documentation>
  10088. </annotation>
  10089. </element>
  10090. <element name="PayPalAccountID" type="xs:string" minOccurs="0" maxOccurs="1">
  10091. <annotation>
  10092. <documentation>
  10093. Seller Paypal Account Id contains the seller EmailId or PayerId or PhoneNo passed during the Request.
  10094. </documentation>
  10095. </annotation>
  10096. </element>
  10097. <element name="SecureMerchantAccountID" type="ns:UserIDType" minOccurs="0" maxOccurs="1">
  10098. <annotation>
  10099. <documentation>
  10100. Unique PayPal customer account identification number (of the seller). This feild is meant for Response. This field is ignored, if passed in the Request.
  10101. </documentation>
  10102. </annotation>
  10103. </element>
  10104. </sequence>
  10105. </complexType>
  10106. <complexType name="OtherPaymentMethodDetailsType">
  10107. <annotation>
  10108. <documentation>
  10109. Lists the Payment Methods (other than PayPal) that the use can pay with e.g. Money Order. <br/>
  10110. Optional.<br/>
  10111. </documentation>
  10112. </annotation>
  10113. <sequence>
  10114. <element name="OtherPaymentMethodId" type="xs:string" minOccurs="0" maxOccurs="1">
  10115. <annotation>
  10116. <documentation>
  10117. The identifier of the Payment Method.
  10118. </documentation>
  10119. </annotation>
  10120. </element>
  10121. <element name="OtherPaymentMethodType" type="xs:string" minOccurs="0" maxOccurs="1">
  10122. <annotation>
  10123. <documentation>
  10124. Valid values are 'Method', 'SubMethod'.
  10125. </documentation>
  10126. </annotation>
  10127. </element>
  10128. <element name="OtherPaymentMethodLabel" type="xs:string" minOccurs="0" maxOccurs="1">
  10129. <annotation>
  10130. <documentation>
  10131. The name of the Payment Method.
  10132. </documentation>
  10133. </annotation>
  10134. </element>
  10135. <element name="OtherPaymentMethodLabelDescription" type="xs:string" minOccurs="0" maxOccurs="1">
  10136. <annotation>
  10137. <documentation>
  10138. The short description of the Payment Method, goes along with the label.
  10139. </documentation>
  10140. </annotation>
  10141. </element>
  10142. <element name="OtherPaymentMethodLongDescriptionTitle" type="xs:string" minOccurs="0" maxOccurs="1">
  10143. <annotation>
  10144. <documentation>
  10145. The title for the long description.
  10146. </documentation>
  10147. </annotation>
  10148. </element>
  10149. <element name="OtherPaymentMethodLongDescription" type="xs:string" minOccurs="0" maxOccurs="1">
  10150. <annotation>
  10151. <documentation>
  10152. The long description of the Payment Method.
  10153. </documentation>
  10154. </annotation>
  10155. </element>
  10156. <element name="OtherPaymentMethodIcon" type="xs:string" minOccurs="0" maxOccurs="1">
  10157. <annotation>
  10158. <documentation>
  10159. The icon of the Payment Method.
  10160. </documentation>
  10161. </annotation>
  10162. </element>
  10163. <element name="OtherPaymentMethodHideLabel" type="xs:boolean" minOccurs="0" maxOccurs="1">
  10164. <annotation>
  10165. <documentation>
  10166. 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.
  10167. </documentation>
  10168. </annotation>
  10169. </element>
  10170. </sequence>
  10171. </complexType>
  10172. <complexType name="BuyerDetailsType">
  10173. <annotation>
  10174. <documentation>
  10175. Details about the buyer's account passed in by the merchant or partner.<br/>
  10176. Optional.<br/>
  10177. </documentation>
  10178. </annotation>
  10179. <sequence>
  10180. <element name="BuyerId" type="xs:string" minOccurs="0">
  10181. <annotation>
  10182. <documentation>
  10183. The client's unique ID for this user.<br/>
  10184. </documentation>
  10185. </annotation>
  10186. </element>
  10187. <element name="BuyerUserName" type="xs:string" minOccurs="0">
  10188. <annotation>
  10189. <documentation>
  10190. The user name of the user at the marketplaces site.<br/>
  10191. </documentation>
  10192. </annotation>
  10193. </element>
  10194. <element name="BuyerRegistrationDate" type="xs:dateTime" minOccurs="0">
  10195. <annotation>
  10196. <documentation>
  10197. Date when the user registered with the marketplace.<br/>
  10198. </documentation>
  10199. </annotation>
  10200. </element>
  10201. <element name="TaxIdDetails" type="ns:TaxIdDetailsType" minOccurs="0" maxOccurs="1">
  10202. <annotation>
  10203. <documentation>
  10204. Details about payer's tax info.<br/>
  10205. Refer to the TaxIdDetailsType for more details.<br/>
  10206. </documentation>
  10207. </annotation>
  10208. </element>
  10209. <element name="IdentificationInfo" type="ns:IdentificationInfoType" minOccurs="0" maxOccurs="1">
  10210. <annotation>
  10211. <documentation>
  10212. Contains information that identifies the buyer. e.g. email address or the external remember me id.
  10213. </documentation>
  10214. </annotation>
  10215. </element>
  10216. </sequence>
  10217. </complexType>
  10218. <complexType name="TaxIdDetailsType">
  10219. <annotation>
  10220. <documentation>
  10221. Details about the payer's tax info passed in by the merchant or partner.<br/>
  10222. Optional.<br/>
  10223. </documentation>
  10224. </annotation>
  10225. <sequence>
  10226. <element name="TaxIdType" type="xs:string" minOccurs="0">
  10227. <annotation>
  10228. <documentation>
  10229. The payer's Tax ID type; CNPJ/CPF for BR country.<br/>
  10230. </documentation>
  10231. </annotation>
  10232. </element>
  10233. <element name="TaxId" type="xs:string" minOccurs="0">
  10234. <annotation>
  10235. <documentation>
  10236. The payer's Tax ID<br/>
  10237. </documentation>
  10238. </annotation>
  10239. </element>
  10240. </sequence>
  10241. </complexType>
  10242. <complexType name="ThreeDSecureRequestType">
  10243. <annotation>
  10244. <documentation>
  10245. The Common 3DS fields. Common for both GTD and DCC API's.
  10246. </documentation>
  10247. </annotation>
  10248. <sequence>
  10249. <element name="Eci3ds" type="xs:string" minOccurs="0"/>
  10250. <element name="Cavv" type="xs:string" minOccurs="0"/>
  10251. <element name="Xid" type="xs:string" minOccurs="0"/>
  10252. <element name="MpiVendor3ds" type="xs:string" minOccurs="0"/>
  10253. <element name="AuthStatus3ds" type="xs:string" minOccurs="0"/>
  10254. </sequence>
  10255. </complexType>
  10256. <complexType name="ThreeDSecureResponseType">
  10257. <annotation>
  10258. <documentation>
  10259. 3DS remaining fields.
  10260. </documentation>
  10261. </annotation>
  10262. <sequence>
  10263. <element name="Vpas" type="xs:string" minOccurs="0"/>
  10264. <element name="EciSubmitted3DS" type="xs:string" minOccurs="0"/>
  10265. </sequence>
  10266. </complexType>
  10267. <complexType name="ThreeDSecureInfoType">
  10268. <annotation>
  10269. <documentation>
  10270. 3DSecureInfoType
  10271. Information about 3D Secure parameters.
  10272. </documentation>
  10273. <!-- add more documentation here -->
  10274. </annotation>
  10275. <sequence>
  10276. <element name="ThreeDSecureRequest" type="ns:ThreeDSecureRequestType" minOccurs="0"/>
  10277. <element name="ThreeDSecureResponse" type="ns:ThreeDSecureResponseType" minOccurs="0"/>
  10278. </sequence>
  10279. </complexType>
  10280. <complexType name="CreditCardDetailsType">
  10281. <annotation>
  10282. <documentation>
  10283. CreditCardDetailsType
  10284. Information about a Credit Card.
  10285. </documentation>
  10286. <!-- add more documentation here -->
  10287. </annotation>
  10288. <sequence>
  10289. <element name="CreditCardType" type="ns:CreditCardTypeType" minOccurs="0"/>
  10290. <element name="CreditCardNumber" type="xs:string" minOccurs="0"/>
  10291. <element name="ExpMonth" type="xs:int" minOccurs="0"/>
  10292. <element name="ExpYear" type="xs:int" minOccurs="0"/>
  10293. <element name="CardOwner" type="ns:PayerInfoType" minOccurs="0"/>
  10294. <element name="CVV2" type="xs:string" minOccurs="0"/>
  10295. <element name="StartMonth" type="xs:int" minOccurs="0"/>
  10296. <element name="StartYear" type="xs:int" minOccurs="0"/>
  10297. <element name="IssueNumber" type="xs:string" minOccurs="0"/>
  10298. <element name="ThreeDSecureRequest" type="ns:ThreeDSecureRequestType" minOccurs="0"/>
  10299. </sequence>
  10300. </complexType>
  10301. <complexType name="ShippingOptionType">
  10302. <annotation>
  10303. <documentation>
  10304. Fallback shipping options type.
  10305. </documentation>
  10306. </annotation>
  10307. <sequence>
  10308. <element name="ShippingOptionIsDefault" type="xs:string" minOccurs="0" maxOccurs="1"/>
  10309. <element name="ShippingOptionAmount" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1"/>
  10310. <element name="ShippingOptionName" type="xs:string" minOccurs="0" maxOccurs="1"/>
  10311. </sequence>
  10312. </complexType>
  10313. <complexType name="UserSelectedOptionType">
  10314. <annotation>
  10315. <documentation>
  10316. Information on user selected options
  10317. </documentation>
  10318. </annotation>
  10319. <sequence>
  10320. <element name="ShippingCalculationMode" type="xs:string" minOccurs="0" maxOccurs="1"/>
  10321. <element name="InsuranceOptionSelected" type="xs:string" minOccurs="0" maxOccurs="1"/>
  10322. <element name="ShippingOptionIsDefault" type="xs:string" minOccurs="0" maxOccurs="1"/>
  10323. <element name="ShippingOptionAmount" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1"/>
  10324. <element name="ShippingOptionName" type="xs:string" minOccurs="0" maxOccurs="1"/>
  10325. </sequence>
  10326. </complexType>
  10327. <complexType name="CreditCardNumberTypeType">
  10328. <annotation>
  10329. <documentation>
  10330. </documentation>
  10331. </annotation>
  10332. <sequence>
  10333. <element name="CreditCardType" type="ns:CreditCardTypeType" minOccurs="0" maxOccurs="1"/>
  10334. <element name="CreditCardNumber" type="xs:string" minOccurs="0" maxOccurs="1"/>
  10335. </sequence>
  10336. </complexType>
  10337. <complexType name="ReferenceCreditCardDetailsType">
  10338. <annotation>
  10339. <documentation>
  10340. CreditCardDetailsType for DCC Reference Transaction
  10341. Information about a Credit Card.
  10342. </documentation>
  10343. </annotation>
  10344. <sequence>
  10345. <element name="CreditCardNumberType" type="ns:CreditCardNumberTypeType" minOccurs="0" maxOccurs="1"/>
  10346. <element name="ExpMonth" type="xs:int" minOccurs="0" maxOccurs="1"/>
  10347. <element name="ExpYear" type="xs:int" minOccurs="0" maxOccurs="1"/>
  10348. <element name="CardOwnerName" type="ns:PersonNameType" minOccurs="0" maxOccurs="1"/>
  10349. <element name="BillingAddress" type="ns:AddressType" minOccurs="0" maxOccurs="1"/>
  10350. <element name="CVV2" type="xs:string" minOccurs="0" maxOccurs="1"/>
  10351. <element name="StartMonth" type="xs:int" minOccurs="0" maxOccurs="1"/>
  10352. <element name="StartYear" type="xs:int" minOccurs="0" maxOccurs="1"/>
  10353. <element name="IssueNumber" type="xs:string" minOccurs="0" maxOccurs="1"/>
  10354. </sequence>
  10355. </complexType>
  10356. <!-- new CodeTypes -->
  10357. <simpleType name="PaymentTransactionCodeType">
  10358. <annotation>
  10359. <documentation>
  10360. PaymentTransactionCodeType
  10361. This is the type of a PayPal of which matches the output from IPN
  10362. </documentation>
  10363. </annotation>
  10364. <restriction base="xs:token">
  10365. <enumeration value="none"/>
  10366. <enumeration value="web-accept"/>
  10367. <enumeration value="cart"/>
  10368. <enumeration value="send-money"/>
  10369. <enumeration value="subscr-failed"/>
  10370. <enumeration value="subscr-cancel"/>
  10371. <enumeration value="subscr-payment"/>
  10372. <enumeration value="subscr-signup"/>
  10373. <enumeration value="subscr-eot"/>
  10374. <enumeration value="subscr-modify"/>
  10375. <enumeration value="mercht-pmt"/>
  10376. <enumeration value="mass-pay"/>
  10377. <enumeration value="virtual-terminal"/>
  10378. <enumeration value="integral-evolution"/>
  10379. <enumeration value="express-checkout"/>
  10380. <enumeration value="pro-hosted"/>
  10381. <enumeration value="pro-api"/>
  10382. <enumeration value="credit"/>
  10383. </restriction>
  10384. </simpleType>
  10385. <simpleType name="PaymentStatusCodeType">
  10386. <annotation>
  10387. <documentation>
  10388. PaymentStatusCodeType
  10389. This is the status of a PayPal Payment which matches the output from IPN
  10390. </documentation>
  10391. </annotation>
  10392. <restriction base="xs:token">
  10393. <enumeration value="None"/>
  10394. <enumeration value="Completed"/>
  10395. <enumeration value="Failed"/>
  10396. <enumeration value="Pending"/>
  10397. <enumeration value="Denied"/>
  10398. <enumeration value="Refunded"/>
  10399. <enumeration value="Reversed"/>
  10400. <enumeration value="Canceled-Reversal"/>
  10401. <enumeration value="Processed"/>
  10402. <enumeration value="Partially-Refunded"/>
  10403. <enumeration value="Voided"/>
  10404. <enumeration value="Expired"/>
  10405. <enumeration value="In-Progress"/>
  10406. <enumeration value="Created"/>
  10407. <enumeration value="Completed-Funds-Held"/>
  10408. <enumeration value="Instant"/>
  10409. <enumeration value="Delayed"/>
  10410. </restriction>
  10411. </simpleType>
  10412. <simpleType name="AddressStatusCodeType">
  10413. <annotation>
  10414. <documentation>
  10415. AddressStatusCodeType
  10416. This is the PayPal address status
  10417. </documentation>
  10418. </annotation>
  10419. <restriction base="xs:token">
  10420. <enumeration value="None"/>
  10421. <enumeration value="Confirmed"/>
  10422. <enumeration value="Unconfirmed"/>
  10423. </restriction>
  10424. </simpleType>
  10425. <simpleType name="PaymentActionCodeType">
  10426. <annotation>
  10427. <documentation>
  10428. PaymentDetailsCodeType
  10429. This is the PayPal payment details type (used by DCC and Express Checkout)
  10430. </documentation>
  10431. </annotation>
  10432. <restriction base="xs:token">
  10433. <enumeration value="None"/>
  10434. <enumeration value="Authorization"/>
  10435. <enumeration value="Sale"/>
  10436. <enumeration value="Order"/>
  10437. </restriction>
  10438. </simpleType>
  10439. <simpleType name="FMFPendingTransactionActionType">
  10440. <annotation>
  10441. <documentation>
  10442. This is various actions that a merchant can take on a FMF Pending Transaction.
  10443. </documentation>
  10444. </annotation>
  10445. <restriction base="xs:token">
  10446. <enumeration value="Accept"/>
  10447. <enumeration value="Deny"/>
  10448. </restriction>
  10449. </simpleType>
  10450. <simpleType name="ChannelType">
  10451. <annotation>
  10452. <documentation>
  10453. ChannelType - Type declaration to be used by other schemas.
  10454. This is the PayPal Channel type (used by Express Checkout)
  10455. </documentation>
  10456. </annotation>
  10457. <restriction base="xs:token">
  10458. <enumeration value="Merchant"/>
  10459. <enumeration value="eBayItem"/>
  10460. </restriction>
  10461. </simpleType>
  10462. <simpleType name="TotalType">
  10463. <annotation>
  10464. <documentation>
  10465. TotalType - Type declaration for the label to be displayed
  10466. in MiniCart for UX.
  10467. </documentation>
  10468. </annotation>
  10469. <restriction base="xs:token">
  10470. <enumeration value="Total"/>
  10471. <enumeration value="EstimatedTotal"/>
  10472. </restriction>
  10473. </simpleType>
  10474. <simpleType name="SolutionTypeType">
  10475. <annotation>
  10476. <documentation>
  10477. SolutionTypeType
  10478. This is the PayPal payment Solution details type (used by Express Checkout)
  10479. </documentation>
  10480. </annotation>
  10481. <restriction base="xs:token">
  10482. <enumeration value="Mark"/>
  10483. <enumeration value="Sole"/>
  10484. </restriction>
  10485. </simpleType>
  10486. <simpleType name="AllowedPaymentMethodType">
  10487. <annotation>
  10488. <documentation>
  10489. AllowedPaymentMethodType
  10490. This is the payment Solution merchant needs to specify for Autopay (used by Express Checkout)
  10491. <br/>Optional
  10492. <br/>Default indicates that its merchant supports all funding source
  10493. <br/>InstantPaymentOnly indicates that its merchant only supports instant payment
  10494. <br/>AnyFundingSource allow all funding methods to be chosen by the buyer irrespective of merchant's profile setting
  10495. <br/>InstantFundingSource allow only instant funding methods, block echeck, meft, elevecheck. This will override any merchant profile setting
  10496. </documentation>
  10497. </annotation>
  10498. <restriction base="xs:token">
  10499. <enumeration value="Default"/>
  10500. <enumeration value="InstantPaymentOnly"/>
  10501. <enumeration value="AnyFundingSource"/>
  10502. <enumeration value="InstantFundingSource"/>
  10503. </restriction>
  10504. </simpleType>
  10505. <simpleType name="LandingPageType">
  10506. <annotation>
  10507. <documentation>
  10508. LandingPageType
  10509. This is the PayPal payment Landing Page details type (used by Express Checkout)
  10510. </documentation>
  10511. </annotation>
  10512. <restriction base="xs:token">
  10513. <enumeration value="None"/>
  10514. <enumeration value="Login"/>
  10515. <enumeration value="Billing"/>
  10516. </restriction>
  10517. </simpleType>
  10518. <simpleType name="BillingCodeType">
  10519. <annotation>
  10520. <documentation>
  10521. </documentation>
  10522. </annotation>
  10523. <restriction base="xs:token">
  10524. <enumeration value="None"/>
  10525. <enumeration value="MerchantInitiatedBilling"/>
  10526. <enumeration value="RecurringPayments"/>
  10527. <enumeration value="MerchantInitiatedBillingSingleAgreement"/>
  10528. <enumeration value="ChannelInitiatedBilling"/>
  10529. </restriction>
  10530. </simpleType>
  10531. <simpleType name="ApprovalTypeType">
  10532. <annotation>
  10533. <documentation>
  10534. </documentation>
  10535. </annotation>
  10536. <restriction base="xs:token">
  10537. <enumeration value="BillingAgreement"/>
  10538. <enumeration value="Profile"/>
  10539. </restriction>
  10540. </simpleType>
  10541. <simpleType name="ApprovalSubTypeType">
  10542. <annotation>
  10543. <documentation>
  10544. </documentation>
  10545. </annotation>
  10546. <restriction base="xs:token">
  10547. <enumeration value="None"/>
  10548. <enumeration value="MerchantInitiatedBilling"/>
  10549. </restriction>
  10550. </simpleType>
  10551. <simpleType name="PendingStatusCodeType">
  10552. <annotation>
  10553. <documentation>
  10554. PendingStatusCodeType
  10555. The pending status for a PayPal Payment transaction which matches the output from IPN
  10556. </documentation>
  10557. </annotation>
  10558. <restriction base="xs:token">
  10559. <enumeration value="none"/>
  10560. <enumeration value="echeck"/>
  10561. <enumeration value="intl"/>
  10562. <enumeration value="verify"/>
  10563. <enumeration value="address"/>
  10564. <enumeration value="unilateral"/>
  10565. <enumeration value="other"/>
  10566. <enumeration value="upgrade"/>
  10567. <enumeration value="multi-currency"/>
  10568. <enumeration value="authorization"/>
  10569. <enumeration value="order"/>
  10570. <enumeration value="payment-review"/>
  10571. </restriction>
  10572. </simpleType>
  10573. <simpleType name="ReceiverInfoCodeType">
  10574. <annotation>
  10575. <documentation>
  10576. ReceiverInfoCodeType
  10577. Payee identifier type for MassPay API
  10578. </documentation>
  10579. </annotation>
  10580. <restriction base="xs:token">
  10581. <enumeration value="EmailAddress"/>
  10582. <enumeration value="UserID"/>
  10583. <enumeration value="PhoneNumber"/>
  10584. </restriction>
  10585. </simpleType>
  10586. <simpleType name="ReversalReasonCodeType">
  10587. <annotation>
  10588. <documentation>
  10589. ReversalReasonCodeType
  10590. Reason for a reversal on a PayPal transaction which matches the output from IPN
  10591. </documentation>
  10592. </annotation>
  10593. <restriction base="xs:token">
  10594. <enumeration value="none"/>
  10595. <enumeration value="chargeback"/>
  10596. <enumeration value="guarantee"/>
  10597. <enumeration value="buyer-complaint"/>
  10598. <enumeration value="refund"/>
  10599. <enumeration value="other"/>
  10600. </restriction>
  10601. </simpleType>
  10602. <simpleType name="PaymentCodeType">
  10603. <annotation>
  10604. <documentation>
  10605. PaymentCodeType
  10606. This is the type of PayPal payment which matches the output from IPN.
  10607. </documentation>
  10608. </annotation>
  10609. <restriction base="xs:token">
  10610. <enumeration value="none"/>
  10611. <enumeration value="echeck"/>
  10612. <enumeration value="instant"/>
  10613. </restriction>
  10614. </simpleType>
  10615. <simpleType name="RefundSourceCodeType">
  10616. <annotation>
  10617. <documentation>
  10618. RefundSourceCodeType
  10619. This is the type of PayPal funding source that can be used for auto refund.
  10620. any - Means Merchant doesn't have any preference. PayPal can use any available funding source (Balance or eCheck)
  10621. default - Means merchant's preferred funding source as configured in his profile. (Balance or eCheck)
  10622. instant - Only Balance
  10623. echeck - Merchant prefers echeck. If PayPal balance can cover the refund amount, we will use PayPal balance. (balance or eCheck)
  10624. </documentation>
  10625. </annotation>
  10626. <restriction base="xs:token">
  10627. <enumeration value="any"/>
  10628. <enumeration value="default"/>
  10629. <enumeration value="instant"/>
  10630. <enumeration value="echeck"/>
  10631. </restriction>
  10632. </simpleType>
  10633. <simpleType name="PayPalUserStatusCodeType">
  10634. <annotation>
  10635. <documentation>
  10636. PayPalUserStatusCodeType
  10637. PayPal status of a user Address
  10638. </documentation>
  10639. </annotation>
  10640. <restriction base="xs:token">
  10641. <enumeration value="verified"/>
  10642. <enumeration value="unverified"/>
  10643. </restriction>
  10644. </simpleType>
  10645. <simpleType name="MerchantPullPaymentCodeType">
  10646. <annotation>
  10647. <documentation>
  10648. MerchantPullPaymentCodeType
  10649. Type of Payment to be initiated by the merchant
  10650. </documentation>
  10651. </annotation>
  10652. <restriction base="xs:token">
  10653. <enumeration value="Any"/>
  10654. <enumeration value="InstantOnly"/>
  10655. <enumeration value="EcheckOnly"/>
  10656. </restriction>
  10657. </simpleType>
  10658. <simpleType name="MerchantPullStatusCodeType">
  10659. <annotation>
  10660. <documentation>
  10661. MerchantPullStatusCodeType
  10662. Status of the merchant pull
  10663. </documentation>
  10664. </annotation>
  10665. <restriction base="xs:token">
  10666. <enumeration value="Active"/>
  10667. <enumeration value="Canceled"/>
  10668. </restriction>
  10669. </simpleType>
  10670. <simpleType name="PaymentTransactionStatusCodeType">
  10671. <annotation>
  10672. <documentation>
  10673. PaymentTransactionStatusCodeType
  10674. The status of the PayPal payment.
  10675. </documentation>
  10676. </annotation>
  10677. <restriction base="xs:token">
  10678. <enumeration value="Pending"/>
  10679. <enumeration value="Processing"/>
  10680. <enumeration value="Success"/>
  10681. <enumeration value="Denied"/>
  10682. <enumeration value="Reversed"/>
  10683. </restriction>
  10684. </simpleType>
  10685. <simpleType name="PaymentTransactionClassCodeType">
  10686. <annotation>
  10687. <documentation>
  10688. PaymentTransactionClassCodeType
  10689. The Type of PayPal payment.
  10690. </documentation>
  10691. </annotation>
  10692. <restriction base="xs:token">
  10693. <enumeration value="All"/>
  10694. <enumeration value="Sent"/>
  10695. <enumeration value="Received"/>
  10696. <enumeration value="MassPay"/>
  10697. <enumeration value="MoneyRequest"/>
  10698. <enumeration value="FundsAdded"/>
  10699. <enumeration value="FundsWithdrawn"/>
  10700. <enumeration value="PayPalDebitCard"/>
  10701. <enumeration value="Referral"/>
  10702. <enumeration value="Fee"/>
  10703. <enumeration value="Subscription"/>
  10704. <enumeration value="Dividend"/>
  10705. <enumeration value="Billpay"/>
  10706. <enumeration value="Refund"/>
  10707. <enumeration value="CurrencyConversions"/>
  10708. <enumeration value="BalanceTransfer"/>
  10709. <enumeration value="Reversal"/>
  10710. <enumeration value="Shipping"/>
  10711. <enumeration value="BalanceAffecting"/>
  10712. <enumeration value="ECheck"/>
  10713. </restriction>
  10714. </simpleType>
  10715. <simpleType name="MatchStatusCodeType">
  10716. <annotation>
  10717. <documentation>
  10718. MatchStatusCodeType
  10719. This is the PayPal (street/zip) match code
  10720. </documentation>
  10721. </annotation>
  10722. <restriction base="xs:token">
  10723. <enumeration value="None"/>
  10724. <enumeration value="Matched"/>
  10725. <enumeration value="Unmatched"/>
  10726. </restriction>
  10727. </simpleType>
  10728. <simpleType name="CompleteCodeType">
  10729. <annotation>
  10730. <documentation>
  10731. CompleteCodeType
  10732. This is the PayPal DoCapture CompleteType code
  10733. </documentation>
  10734. </annotation>
  10735. <restriction base="xs:token">
  10736. <enumeration value="NotComplete"/>
  10737. <enumeration value="Complete"/>
  10738. </restriction>
  10739. </simpleType>
  10740. <simpleType name="TransactionEntityType">
  10741. <annotation>
  10742. <documentation>
  10743. TransactionEntityType
  10744. This is the PayPal DoAuthorization TransactionEntityType code
  10745. </documentation>
  10746. </annotation>
  10747. <restriction base="xs:token">
  10748. <enumeration value="None"/>
  10749. <enumeration value="Auth"/>
  10750. <enumeration value="Reauth"/>
  10751. <enumeration value="Order"/>
  10752. <enumeration value="Payment"/>
  10753. </restriction>
  10754. </simpleType>
  10755. <simpleType name="MobileRecipientCodeType">
  10756. <annotation>
  10757. <documentation>
  10758. MobileRecipientCodeType
  10759. These are the accepted types of recipients for mobile-originated transactions
  10760. </documentation>
  10761. </annotation>
  10762. <restriction base="xs:token">
  10763. <enumeration value="PhoneNumber"/>
  10764. <enumeration value="EmailAddress"/>
  10765. </restriction>
  10766. </simpleType>
  10767. <simpleType name="MobilePaymentCodeType">
  10768. <annotation>
  10769. <documentation>
  10770. MobilePaymentCodeType
  10771. These are the accepted types of mobile payments
  10772. </documentation>
  10773. </annotation>
  10774. <restriction base="xs:token">
  10775. <enumeration value="P2P"/>
  10776. <enumeration value="HardGoods"/>
  10777. <enumeration value="Donation"/>
  10778. <enumeration value="TopUp"/>
  10779. </restriction>
  10780. </simpleType>
  10781. <!-- Custom Security Header -->
  10782. <complexType name="CustomSecurityHeaderType">
  10783. <annotation>
  10784. <documentation>
  10785. Custom Securiy Header.
  10786. </documentation>
  10787. </annotation>
  10788. <sequence>
  10789. <element name="eBayAuthToken" type="xs:string" minOccurs="0"/>
  10790. <element name="HardExpirationWarning" type="xs:string" minOccurs="0"/>
  10791. <element name="Credentials" type="ns:UserIdPasswordType" minOccurs="0"/>
  10792. </sequence>
  10793. </complexType>
  10794. <complexType name="UserIdPasswordType">
  10795. <sequence>
  10796. <element name="AppId" type="xs:string" minOccurs="0"/>
  10797. <element name="DevId" type="xs:string" minOccurs="0"/>
  10798. <element name="AuthCert" type="xs:string" minOccurs="0"/>
  10799. <element name="Username" type="xs:string">
  10800. <annotation>
  10801. <documentation>
  10802. The username is the identifier for an account.
  10803. </documentation>
  10804. </annotation>
  10805. </element>
  10806. <element name="Password" type="xs:string">
  10807. <annotation>
  10808. <documentation>
  10809. Password contains the current password associated with the username.
  10810. </documentation>
  10811. </annotation>
  10812. </element>
  10813. <element name="Signature" type="xs:string" minOccurs="0">
  10814. <annotation>
  10815. <documentation>
  10816. Signature for Three Token authentication.
  10817. </documentation>
  10818. </annotation>
  10819. </element>
  10820. <element name="Subject" type="xs:string" minOccurs="0">
  10821. <annotation>
  10822. <documentation>
  10823. This field identifies an account (e.g., payment) on whose behalf the operation is being performed.
  10824. For instance one account holder may delegate the abililty to perform certain operations
  10825. to another account holder. This delegation is done through a separate mechanism.
  10826. If the base username has not been authorized by the subject the request will be rejected.
  10827. </documentation>
  10828. </annotation>
  10829. </element>
  10830. <element name="AuthToken" type="xs:string" minOccurs="0">
  10831. <annotation>
  10832. <documentation>
  10833. Authentication Session Token for authentication and authorization.
  10834. </documentation>
  10835. </annotation>
  10836. </element>
  10837. </sequence>
  10838. </complexType>
  10839. <complexType name="SetCustomerBillingAgreementRequestDetailsType">
  10840. <sequence>
  10841. <element name="BillingAgreementDetails" type="ns:BillingAgreementDetailsType" minOccurs="1" maxOccurs="1">
  10842. <annotation>
  10843. <documentation>
  10844. </documentation>
  10845. </annotation>
  10846. </element>
  10847. <element name="ReturnURL" type="xs:string" minOccurs="1" maxOccurs="1">
  10848. <annotation>
  10849. <documentation>
  10850. </documentation>
  10851. </annotation>
  10852. </element>
  10853. <element name="CancelURL" type="xs:string" minOccurs="1" maxOccurs="1">
  10854. <annotation>
  10855. <documentation>
  10856. </documentation>
  10857. </annotation>
  10858. </element>
  10859. <element name="LocaleCode" type="xs:string" minOccurs="0" maxOccurs="1">
  10860. <annotation>
  10861. <documentation>
  10862. </documentation>
  10863. </annotation>
  10864. </element>
  10865. <element name="PageStyle" type="xs:string" minOccurs="0" maxOccurs="1">
  10866. <annotation>
  10867. <documentation>
  10868. </documentation>
  10869. </annotation>
  10870. </element>
  10871. <element name="cpp-header-image" type="xs:string" minOccurs="0" maxOccurs="1">
  10872. <annotation>
  10873. <documentation>
  10874. </documentation>
  10875. </annotation>
  10876. </element>
  10877. <element name="cpp-header-border-color" type="xs:string" minOccurs="0" maxOccurs="1">
  10878. <annotation>
  10879. <documentation>
  10880. </documentation>
  10881. </annotation>
  10882. </element>
  10883. <element name="cpp-header-back-color" type="xs:string" minOccurs="0" maxOccurs="1">
  10884. <annotation>
  10885. <documentation>
  10886. </documentation>
  10887. </annotation>
  10888. </element>
  10889. <element name="cpp-payflow-color" type="xs:string" minOccurs="0" maxOccurs="1">
  10890. <annotation>
  10891. <documentation>
  10892. </documentation>
  10893. </annotation>
  10894. </element>
  10895. <element name="BuyerEmail" type="ns:EmailAddressType" minOccurs="0" maxOccurs="1">
  10896. <annotation>
  10897. <documentation>
  10898. </documentation>
  10899. </annotation>
  10900. </element>
  10901. <element name="ReqBillingAddress" type="xs:string" minOccurs="0">
  10902. <annotation>
  10903. <documentation>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.
  10904. <br/>
  10905. <br/>
  10906. Optional
  10907. <br/>
  10908. <br/>Character length and limitations: One single-byte numeric character.
  10909. </documentation>
  10910. </annotation>
  10911. </element>
  10912. </sequence>
  10913. </complexType>
  10914. <complexType name="GetBillingAgreementCustomerDetailsResponseDetailsType">
  10915. <sequence>
  10916. <element name="PayerInfo" type="ns:PayerInfoType" minOccurs="1" maxOccurs="1">
  10917. <annotation>
  10918. <documentation>
  10919. </documentation>
  10920. </annotation>
  10921. </element>
  10922. <element name="BillingAddress" type="ns:AddressType" minOccurs="0">
  10923. <annotation>
  10924. <documentation>Customer's billing address.
  10925. <br/>
  10926. <br/>
  10927. Optional
  10928. <br/>
  10929. <br/>
  10930. 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.
  10931. </documentation>
  10932. </annotation>
  10933. </element>
  10934. </sequence>
  10935. </complexType>
  10936. <complexType name="DeviceDetailsType">
  10937. <sequence>
  10938. <element name="DeviceID" type="xs:string" minOccurs="0">
  10939. <annotation>
  10940. <documentation>Device ID <br/><br/>Optional<br/><br/>
  10941. Character length and limits: 256 single-byte characters <br/>
  10942. DeviceID length morethan 256 is truncated
  10943. </documentation>
  10944. </annotation>
  10945. </element>
  10946. </sequence>
  10947. </complexType>
  10948. <complexType name="SenderDetailsType">
  10949. <sequence>
  10950. <element name="DeviceDetails" type="ns:DeviceDetailsType" minOccurs="0">
  10951. <annotation>
  10952. <documentation>
  10953. </documentation>
  10954. </annotation>
  10955. </element>
  10956. </sequence>
  10957. </complexType>
  10958. <complexType name="DoReferenceTransactionRequestDetailsType">
  10959. <sequence>
  10960. <element name="ReferenceID" type="xs:string" minOccurs="1" maxOccurs="1">
  10961. <annotation>
  10962. <documentation>
  10963. </documentation>
  10964. </annotation>
  10965. </element>
  10966. <element name="PaymentAction" type="ns:PaymentActionCodeType" minOccurs="1" maxOccurs="1">
  10967. <annotation>
  10968. <documentation>
  10969. </documentation>
  10970. </annotation>
  10971. </element>
  10972. <element name="PaymentType" type="ns:MerchantPullPaymentCodeType" minOccurs="0" maxOccurs="1">
  10973. <annotation>
  10974. <documentation>
  10975. </documentation>
  10976. </annotation>
  10977. </element>
  10978. <element name="PaymentDetails" type="ns:PaymentDetailsType" minOccurs="1" maxOccurs="1">
  10979. <annotation>
  10980. <documentation>
  10981. </documentation>
  10982. </annotation>
  10983. </element>
  10984. <element name="CreditCard" type="ns:ReferenceCreditCardDetailsType" minOccurs="0" maxOccurs="1">
  10985. <annotation>
  10986. <documentation>
  10987. </documentation>
  10988. </annotation>
  10989. </element>
  10990. <element name="IPAddress" type="xs:string" minOccurs="0" maxOccurs="1">
  10991. <annotation>
  10992. <documentation>
  10993. </documentation>
  10994. </annotation>
  10995. </element>
  10996. <element name="MerchantSessionId" type="xs:string" minOccurs="0" maxOccurs="1">
  10997. <annotation>
  10998. <documentation>
  10999. </documentation>
  11000. </annotation>
  11001. </element>
  11002. <element name="ReqConfirmShipping" type="xs:string" minOccurs="0" maxOccurs="1">
  11003. <annotation>
  11004. <documentation>
  11005. </documentation>
  11006. </annotation>
  11007. </element>
  11008. <element name="SoftDescriptor" type="xs:string" minOccurs="0" maxOccurs="1">
  11009. <annotation>
  11010. <documentation>
  11011. </documentation>
  11012. </annotation>
  11013. </element>
  11014. <element name="SenderDetails" type="ns:SenderDetailsType" minOccurs="0" maxOccurs="1">
  11015. <annotation>
  11016. <documentation>
  11017. </documentation>
  11018. </annotation>
  11019. </element>
  11020. </sequence>
  11021. </complexType>
  11022. <complexType name="DoReferenceTransactionResponseDetailsType">
  11023. <sequence>
  11024. <element name="BillingAgreementID" type="xs:string" minOccurs="0" maxOccurs="1">
  11025. <annotation>
  11026. <documentation>
  11027. </documentation>
  11028. </annotation>
  11029. </element>
  11030. <element name="PaymentInfo" type="ns:PaymentInfoType" minOccurs="0" maxOccurs="1">
  11031. <annotation>
  11032. <documentation>
  11033. </documentation>
  11034. </annotation>
  11035. </element>
  11036. <element name="Amount" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  11037. <annotation>
  11038. <documentation>
  11039. </documentation>
  11040. </annotation>
  11041. </element>
  11042. <element name="AVSCode" type="xs:string" minOccurs="0" maxOccurs="1">
  11043. <annotation>
  11044. <documentation>
  11045. </documentation>
  11046. </annotation>
  11047. </element>
  11048. <element name="CVV2Code" type="xs:string" minOccurs="0" maxOccurs="1">
  11049. <annotation>
  11050. <documentation>
  11051. </documentation>
  11052. </annotation>
  11053. </element>
  11054. <element name="TransactionID" type="ns:TransactionId" minOccurs="0" maxOccurs="1">
  11055. <annotation>
  11056. <documentation>
  11057. </documentation>
  11058. </annotation>
  11059. </element>
  11060. <element name="PaymentAdviceCode" type="xs:string" minOccurs="0" maxOccurs="1">
  11061. <annotation>
  11062. <documentation>
  11063. Response code from the processor when a recurring transaction is declined
  11064. </documentation>
  11065. </annotation>
  11066. </element>
  11067. </sequence>
  11068. </complexType>
  11069. <complexType name="DoNonReferencedCreditRequestDetailsType">
  11070. <sequence>
  11071. <element name="Amount" type="cc:BasicAmountType">
  11072. <annotation>
  11073. <documentation>
  11074. </documentation>
  11075. </annotation>
  11076. </element>
  11077. <element name="NetAmount" type="cc:BasicAmountType" minOccurs="0">
  11078. <annotation>
  11079. <documentation>
  11080. </documentation>
  11081. </annotation>
  11082. </element>
  11083. <element name="TaxAmount" type="cc:BasicAmountType" minOccurs="0">
  11084. <annotation>
  11085. <documentation>
  11086. </documentation>
  11087. </annotation>
  11088. </element>
  11089. <element name="ShippingAmount" type="cc:BasicAmountType" minOccurs="0">
  11090. <annotation>
  11091. <documentation>
  11092. </documentation>
  11093. </annotation>
  11094. </element>
  11095. <element name="CreditCard" type="ns:CreditCardDetailsType">
  11096. <annotation>
  11097. <documentation>
  11098. </documentation>
  11099. </annotation>
  11100. </element>
  11101. <element name="ReceiverEmail" type="xs:string" minOccurs="0">
  11102. <annotation>
  11103. <documentation>
  11104. </documentation>
  11105. </annotation>
  11106. </element>
  11107. <element name="Comment" type="xs:string" minOccurs="0">
  11108. <annotation>
  11109. <documentation>
  11110. </documentation>
  11111. </annotation>
  11112. </element>
  11113. </sequence>
  11114. </complexType>
  11115. <complexType name="DoNonReferencedCreditResponseDetailsType">
  11116. <sequence>
  11117. <element name="Amount" type="cc:BasicAmountType">
  11118. <annotation>
  11119. <documentation>
  11120. </documentation>
  11121. </annotation>
  11122. </element>
  11123. <element name="TransactionID" type="ns:TransactionId">
  11124. <annotation>
  11125. <documentation>
  11126. </documentation>
  11127. </annotation>
  11128. </element>
  11129. </sequence>
  11130. </complexType>
  11131. <!-- BOARDING DATA TYPES -->
  11132. <element name="EnterBoardingRequestDetails" type="ns:EnterBoardingRequestDetailsType"/>
  11133. <element name="GetBoardingDetailsResponseDetails" type="ns:GetBoardingDetailsResponseDetailsType"/>
  11134. <complexType name="EnterBoardingRequestDetailsType">
  11135. <sequence>
  11136. <element name="ProgramCode" type="xs:string">
  11137. <annotation>
  11138. <documentation>
  11139. Onboarding program code given to you by PayPal.
  11140. <br/>
  11141. <br/>
  11142. <b>Required</b>
  11143. <br/>
  11144. <br/>
  11145. Character length and limitations: 64 alphanumeric characters</documentation>
  11146. </annotation>
  11147. </element>
  11148. <element name="ProductList" type="xs:string">
  11149. <annotation>
  11150. <documentation>
  11151. A list of comma-separated values that indicate the PayPal products you are implementing for this merchant:
  11152. <br/>
  11153. <br/>
  11154. Direct Payment (dp) allows payments by credit card without requiring the customer to have a PayPal account.
  11155. <br/>
  11156. <br/>
  11157. Express Checkout (ec) allows customers to fund transactions with their PayPal account.
  11158. <br/>
  11159. <br/>
  11160. Authorization and Capture (auth_settle) allows merchants to verify availability of funds in a PayPal account, but capture them at a later time.
  11161. <br/>
  11162. <br/>
  11163. Administrative APIs (admin_api) is a collection of the PayPal APIs for transaction searching, getting transaction details, refunding, and mass payments.
  11164. <br/>
  11165. <br/>
  11166. <b>Required</b>
  11167. <br/>
  11168. <br/>
  11169. Character length and limitations: 64 alphanumeric characters</documentation>
  11170. </annotation>
  11171. </element>
  11172. <element name="PartnerCustom" type="xs:string" minOccurs="0">
  11173. <annotation>
  11174. <documentation>
  11175. Any custom information you want to store for this partner
  11176. <br/>
  11177. <br/>
  11178. Optional
  11179. <br/>
  11180. <br/>
  11181. Character length and limitations: 256 alphanumeric characters</documentation>
  11182. </annotation>
  11183. </element>
  11184. <element name="ImageUrl" type="xs:string" minOccurs="0">
  11185. <annotation>
  11186. <documentation>
  11187. The URL for the logo displayed on the PayPal Partner Welcome Page.
  11188. <br/>
  11189. <br/>
  11190. Optional
  11191. <br/>
  11192. <br/>
  11193. Character length and limitations: 2,048 alphanumeric characters</documentation>
  11194. </annotation>
  11195. </element>
  11196. <element name="MarketingCategory" type="ns:MarketingCategoryType" minOccurs="0">
  11197. <annotation>
  11198. <documentation>
  11199. Marketing category tha configures the graphic displayed n the PayPal Partner Welcome page.</documentation>
  11200. </annotation>
  11201. </element>
  11202. <element name="BusinessInfo" type="ns:BusinessInfoType" minOccurs="0">
  11203. <annotation>
  11204. <documentation>
  11205. Information about the merchant’s business</documentation>
  11206. </annotation>
  11207. </element>
  11208. <element name="OwnerInfo" type="ns:BusinessOwnerInfoType" minOccurs="0">
  11209. <annotation>
  11210. <documentation>
  11211. Information about the merchant (the business owner)</documentation>
  11212. </annotation>
  11213. </element>
  11214. <element name="BankAccount" type="ns:BankAccountDetailsType" minOccurs="0">
  11215. <annotation>
  11216. <documentation>
  11217. Information about the merchant's bank account</documentation>
  11218. </annotation>
  11219. </element>
  11220. </sequence>
  11221. </complexType>
  11222. <simpleType name="MarketingCategoryType">
  11223. <annotation>
  11224. <documentation>
  11225. MarketingCategoryType
  11226. </documentation>
  11227. </annotation>
  11228. <restriction base="xs:token">
  11229. <enumeration value="Marketing-Category-Default"/>
  11230. <enumeration value="Marketing-Category1"/>
  11231. <enumeration value="Marketing-Category2"/>
  11232. <enumeration value="Marketing-Category3"/>
  11233. <enumeration value="Marketing-Category4"/>
  11234. <enumeration value="Marketing-Category5"/>
  11235. <enumeration value="Marketing-Category6"/>
  11236. <enumeration value="Marketing-Category7"/>
  11237. <enumeration value="Marketing-Category8"/>
  11238. <enumeration value="Marketing-Category9"/>
  11239. <enumeration value="Marketing-Category10"/>
  11240. <enumeration value="Marketing-Category11"/>
  11241. <enumeration value="Marketing-Category12"/>
  11242. <enumeration value="Marketing-Category13"/>
  11243. <enumeration value="Marketing-Category14"/>
  11244. <enumeration value="Marketing-Category15"/>
  11245. <enumeration value="Marketing-Category16"/>
  11246. <enumeration value="Marketing-Category17"/>
  11247. <enumeration value="Marketing-Category18"/>
  11248. <enumeration value="Marketing-Category19"/>
  11249. <enumeration value="Marketing-Category20"/>
  11250. </restriction>
  11251. </simpleType>
  11252. <complexType name="BusinessInfoType">
  11253. <annotation>
  11254. <documentation>
  11255. BusinessInfoType
  11256. </documentation>
  11257. </annotation>
  11258. <sequence>
  11259. <element name="Type" type="ns:BusinessTypeType" minOccurs="0">
  11260. <annotation>
  11261. <documentation>
  11262. Type of business, such as corporation or sole proprietorship</documentation>
  11263. </annotation>
  11264. </element>
  11265. <element name="Name" type="ns:NameType" minOccurs="0">
  11266. <annotation>
  11267. <documentation>
  11268. Official name of business
  11269. <br/>
  11270. <br/>
  11271. Character length and limitations: 75 alphanumeric characters</documentation>
  11272. </annotation>
  11273. </element>
  11274. <element name="Address" type="ns:AddressType" minOccurs="0">
  11275. <annotation>
  11276. <documentation>
  11277. Merchant’s business postal address</documentation>
  11278. </annotation>
  11279. </element>
  11280. <element name="WorkPhone" type="xs:string" minOccurs="0">
  11281. <annotation>
  11282. <documentation>
  11283. Business’s primary telephone number
  11284. <br/>
  11285. <br/>
  11286. Character length and limitations: 20 alphanumeric characters</documentation>
  11287. </annotation>
  11288. </element>
  11289. <element name="Category" type="ns:BusinessCategoryType" minOccurs="0">
  11290. <annotation>
  11291. <documentation>
  11292. Line of business, as defined in the enumerations</documentation>
  11293. </annotation>
  11294. </element>
  11295. <element name="SubCategory" type="ns:BusinessSubCategoryType" minOccurs="0">
  11296. <annotation>
  11297. <documentation>
  11298. Business sub-category, as defined in the enumerations</documentation>
  11299. </annotation>
  11300. </element>
  11301. <element name="AveragePrice" type="ns:AverageTransactionPriceType" minOccurs="0">
  11302. <annotation>
  11303. <documentation>
  11304. Average transaction price, as defined by the enumerations.
  11305. <table>
  11306. <tr>
  11307. <th>Enumeration</th>
  11308. <th>Meaning</th>
  11309. </tr>
  11310. <tr>
  11311. <td/>
  11312. <td/>
  11313. </tr>AverageTransactionPrice-Not-Applicable
  11314. <tr>
  11315. <td>AverageTransactionPrice-Range1</td>
  11316. <td>Less than $25 USD</td>
  11317. </tr>
  11318. <tr>
  11319. <td>AverageTransactionPrice-Range2</td>
  11320. <td>$25 USD to $50 USD</td>
  11321. </tr>
  11322. <tr>
  11323. <td>AverageTransactionPrice-Range3</td>
  11324. <td>$50 USD to $100 USD</td>
  11325. </tr>
  11326. <tr>
  11327. <td>AverageTransactionPrice-Range4</td>
  11328. <td>$100 USD to $250 USD</td>
  11329. </tr>
  11330. <tr>
  11331. <td>AverageTransactionPrice-Range5</td>
  11332. <td>$250 USD to $500 USD</td>
  11333. </tr>
  11334. <tr>
  11335. <td>AverageTransactionPrice-Range6</td>
  11336. <td>$500 USD to $1,000 USD</td>
  11337. </tr>
  11338. <tr>
  11339. <td>AverageTransactionPrice-Range7</td>
  11340. <td> $1,000 USD to $2,000 USD</td>
  11341. </tr>
  11342. <tr>
  11343. <td>AverageTransactionPrice-Range8</td>
  11344. <td>$2,000 USD to $5,000 USD</td>
  11345. </tr>
  11346. <tr>
  11347. <td>AverageTransactionPrice-Range9</td>
  11348. <td>$5,000 USD to $10,000 USD</td>
  11349. </tr>
  11350. <tr>
  11351. <td>AverageTransactionPrice-Range10</td>
  11352. <td>More than $10,000 USD</td>
  11353. </tr>
  11354. </table>
  11355. </documentation>
  11356. </annotation>
  11357. </element>
  11358. <element name="AverageMonthlyVolume" type="ns:AverageMonthlyVolumeType" minOccurs="0">
  11359. <annotation>
  11360. <documentation>
  11361. Average monthly sales volume, as defined by the enumerations.
  11362. <table>
  11363. <tr>
  11364. <th>Enumeration</th>
  11365. <th>Meaning</th>
  11366. </tr>
  11367. <tr>
  11368. <td>AverageMonthlyVolume-Not-Applicable</td>
  11369. <td/>
  11370. </tr>
  11371. <tr>
  11372. <td>AverageMonthlyVolume-Range1</td>
  11373. <td>Less than $1,000 USD</td>
  11374. </tr>
  11375. <tr>
  11376. <td>AverageMonthlyVolume-Range2</td>
  11377. <td>$1,000 USD to $5,000 USD</td>
  11378. </tr>
  11379. <tr>
  11380. <td>AverageMonthlyVolume-Range3</td>
  11381. <td>$5,000 USD to $25,000 USD</td>
  11382. </tr>
  11383. <tr>
  11384. <td>AverageMonthlyVolume-Range4</td>
  11385. <td>$25,000 USD to $100,000 USD</td>
  11386. </tr>
  11387. <tr>
  11388. <td>AverageMonthlyVolume-Range5</td>
  11389. <td>$100,000 USD to $1,000,000 USD</td>
  11390. </tr>
  11391. <tr>
  11392. <td>AverageMonthlyVolume-Range6</td>
  11393. <td>More than $1,000,000 USD</td>
  11394. </tr>
  11395. </table>
  11396. </documentation>
  11397. </annotation>
  11398. </element>
  11399. <element name="SalesVenue" type="ns:SalesVenueType" minOccurs="0">
  11400. <annotation>
  11401. <documentation>
  11402. Main sales venue, such as eBay</documentation>
  11403. </annotation>
  11404. </element>
  11405. <element name="Website" type="xs:string" minOccurs="0">
  11406. <annotation>
  11407. <documentation>
  11408. Primary URL of business
  11409. <br/>
  11410. <br/>Character length and limitations: 2,048 alphanumeric characters</documentation>
  11411. </annotation>
  11412. </element>
  11413. <element name="RevenueFromOnlineSales" type="ns:PercentageRevenueFromOnlineSalesType" minOccurs="0">
  11414. <annotation>
  11415. <documentation>
  11416. Percentage of revenue attributable to online sales, as defined by the enumerations
  11417. <br/>
  11418. <br/>
  11419. <table>
  11420. <tr>
  11421. <th>Enumeration</th>
  11422. <th>Meaning</th>
  11423. </tr>
  11424. <tr>
  11425. <td/>
  11426. <td/>
  11427. </tr>PercentageRevenueFromOnlineSales-Not-Applicable
  11428. <tr>
  11429. <td>PercentageRevenueFromOnlineSales-Range1</td>
  11430. <td>Less than 25%</td>
  11431. </tr>
  11432. <tr>
  11433. <td>PercentageRevenueFromOnlineSales-Range2</td>
  11434. <td>25% to 50%</td>
  11435. </tr>
  11436. <tr>
  11437. <td>PercentageRevenueFromOnlineSales-Range3</td>
  11438. <td>50% to 75%</td>
  11439. </tr>
  11440. <tr>
  11441. <td>PercentageRevenueFromOnlineSales-Range4</td>
  11442. <td>75% to 100%</td>
  11443. </tr>
  11444. </table>
  11445. </documentation>
  11446. </annotation>
  11447. </element>
  11448. <element name="BusinessEstablished" type="xs:dateTime" minOccurs="0">
  11449. <annotation>
  11450. <documentation>
  11451. Date the merchant’s business was established</documentation>
  11452. </annotation>
  11453. </element>
  11454. <element name="CustomerServiceEmail" type="ns:EmailAddressType" minOccurs="0">
  11455. <annotation>
  11456. <documentation>
  11457. Email address to contact business’s customer service
  11458. <br/>
  11459. <br/>
  11460. Character length and limitations: 127 alphanumeric characters</documentation>
  11461. </annotation>
  11462. </element>
  11463. <element name="CustomerServicePhone" type="xs:string" minOccurs="0">
  11464. <annotation>
  11465. <documentation>
  11466. Telephone number to contact business’s customer service
  11467. <br/>
  11468. <br/>Character length and limitations: 32 alphanumeric characters</documentation>
  11469. </annotation>
  11470. </element>
  11471. </sequence>
  11472. </complexType>
  11473. <simpleType name="BusinessTypeType">
  11474. <annotation>
  11475. <documentation>
  11476. BusinessTypeType
  11477. </documentation>
  11478. </annotation>
  11479. <restriction base="xs:token">
  11480. <enumeration value="Unknown"/>
  11481. <enumeration value="Individual"/>
  11482. <enumeration value="Proprietorship"/>
  11483. <enumeration value="Partnership"/>
  11484. <enumeration value="Corporation"/>
  11485. <enumeration value="Nonprofit"/>
  11486. <enumeration value="Government"/>
  11487. </restriction>
  11488. </simpleType>
  11489. <simpleType name="BusinessCategoryType">
  11490. <annotation>
  11491. <documentation>
  11492. BusinessCategoryType
  11493. </documentation>
  11494. </annotation>
  11495. <restriction base="xs:token">
  11496. <enumeration value="Category-Unspecified"/>
  11497. <enumeration value="Antiques"/>
  11498. <enumeration value="Arts"/>
  11499. <enumeration value="Automotive"/>
  11500. <enumeration value="Beauty"/>
  11501. <enumeration value="Books"/>
  11502. <enumeration value="Business"/>
  11503. <enumeration value="Cameras-and-Photography"/>
  11504. <enumeration value="Clothing"/>
  11505. <enumeration value="Collectibles"/>
  11506. <enumeration value="Computer-Hardware-and-Software"/>
  11507. <enumeration value="Culture-and-Religion"/>
  11508. <enumeration value="Electronics-and-Telecom"/>
  11509. <enumeration value="Entertainment"/>
  11510. <enumeration value="Entertainment-Memorabilia"/>
  11511. <enumeration value="Food-Drink-and-Nutrition"/>
  11512. <enumeration value="Gifts-and-Flowers"/>
  11513. <enumeration value="Hobbies-Toys-and-Games"/>
  11514. <enumeration value="Home-and-Garden"/>
  11515. <enumeration value="Internet-and-Network-Services"/>
  11516. <enumeration value="Media-and-Entertainment"/>
  11517. <enumeration value="Medical-and-Pharmaceutical"/>
  11518. <enumeration value="Money-Service-Businesses"/>
  11519. <enumeration value="Non-Profit-Political-and-Religion"/>
  11520. <enumeration value="Not-Elsewhere-Classified"/>
  11521. <enumeration value="Pets-and-Animals"/>
  11522. <enumeration value="Real-Estate"/>
  11523. <enumeration value="Services"/>
  11524. <enumeration value="Sports-and-Recreation"/>
  11525. <enumeration value="Travel"/>
  11526. <enumeration value="Other-Categories"/>
  11527. </restriction>
  11528. </simpleType>
  11529. <simpleType name="BusinessSubCategoryType">
  11530. <annotation>
  11531. <documentation>
  11532. BusinessSubCategoryType
  11533. </documentation>
  11534. </annotation>
  11535. <restriction base="xs:token">
  11536. <enumeration value="SubCategory-Unspecified"/>
  11537. <enumeration value="ANTIQUES-General"/>
  11538. <enumeration value="ANTIQUES-Antiquities"/>
  11539. <enumeration value="ANTIQUES-Decorative"/>
  11540. <enumeration value="ANTIQUES-Books-Manuscripts"/>
  11541. <enumeration value="ANTIQUES-Furniture"/>
  11542. <enumeration value="ANTIQUES-Glass"/>
  11543. <enumeration value="ANTIQUES-RugsCarpets"/>
  11544. <enumeration value="ANTIQUES-Pottery"/>
  11545. <enumeration value="ANTIQUES-Cultural"/>
  11546. <enumeration value="ANTIQUES-Artifacts-Grave-related-and-Native-American-Crafts"/>
  11547. <enumeration value="ARTSANDCRAFTS-General"/>
  11548. <enumeration value="ARTSANDCRAFTS-Art-Dealer-and-Galleries"/>
  11549. <enumeration value="ARTSANDCRAFTS-Prints"/>
  11550. <enumeration value="ARTSANDCRAFTS-Painting"/>
  11551. <enumeration value="ARTSANDCRAFTS-Photography"/>
  11552. <enumeration value="ARTSANDCRAFTS-Reproductions"/>
  11553. <enumeration value="ARTSANDCRAFTS-Sculptures"/>
  11554. <enumeration value="ARTSANDCRAFTS-Woodworking"/>
  11555. <enumeration value="ARTSANDCRAFTS-Art-and-Craft-Supplies"/>
  11556. <enumeration value="ARTSANDCRAFTS-Fabrics-and-Sewing"/>
  11557. <enumeration value="ARTSANDCRAFTS-Quilting"/>
  11558. <enumeration value="ARTSANDCRAFTS-Scrapbooking"/>
  11559. <enumeration value="AUTOMOTIVE-General"/>
  11560. <enumeration value="AUTOMOTIVE-Autos"/>
  11561. <enumeration value="AUTOMOTIVE-Aviation"/>
  11562. <enumeration value="AUTOMOTIVE-Motorcycles"/>
  11563. <enumeration value="AUTOMOTIVE-Parts-and-Supplies"/>
  11564. <enumeration value="AUTOMOTIVE-Services"/>
  11565. <enumeration value="AUTOMOTIVE-Vintage-and-Collectible-Vehicles"/>
  11566. <enumeration value="BEAUTY-General"/>
  11567. <enumeration value="BEAUTY-Body-Care-Personal-Hygiene"/>
  11568. <enumeration value="BEAUTY-Fragrances-and-Perfumes"/>
  11569. <enumeration value="BEAUTY-Makeup"/>
  11570. <enumeration value="BOOKS-General"/>
  11571. <enumeration value="BOOKS-Audio-Books"/>
  11572. <enumeration value="BOOKS-Children-Books"/>
  11573. <enumeration value="BOOKS-Computer-Books"/>
  11574. <enumeration value="BOOKS-Educational-and-Textbooks"/>
  11575. <enumeration value="BOOKS-Magazines"/>
  11576. <enumeration value="BOOKS-Fiction-and-Literature"/>
  11577. <enumeration value="BOOKS-NonFiction"/>
  11578. <enumeration value="BOOKS-Vintage-and-Collectibles"/>
  11579. <enumeration value="BUSINESS-General"/>
  11580. <enumeration value="BUSINESS-Agricultural"/>
  11581. <enumeration value="BUSINESS-Construction"/>
  11582. <enumeration value="BUSINESS-Educational"/>
  11583. <enumeration value="BUSINESS-Industrial"/>
  11584. <enumeration value="BUSINESS-Office-Supplies-and-Equipment"/>
  11585. <enumeration value="BUSINESS-GeneralServices"/>
  11586. <enumeration value="BUSINESS-Advertising"/>
  11587. <enumeration value="BUSINESS-Employment"/>
  11588. <enumeration value="BUSINESS-Marketing"/>
  11589. <enumeration value="BUSINESS-Meeting-Planners"/>
  11590. <enumeration value="BUSINESS-Messaging-and-Paging-Services"/>
  11591. <enumeration value="BUSINESS-Seminars"/>
  11592. <enumeration value="BUSINESS-Publishing"/>
  11593. <enumeration value="BUSINESS-Shipping-and-Packaging"/>
  11594. <enumeration value="BUSINESS-Wholesale"/>
  11595. <enumeration value="BUSINESS-Industrial-Solvents"/>
  11596. <enumeration value="CAMERASANDPHOTOGRAPHY-General"/>
  11597. <enumeration value="CAMERASANDPHOTOGRAPHY-Accessories"/>
  11598. <enumeration value="CAMERASANDPHOTOGRAPHY-Cameras"/>
  11599. <enumeration value="CAMERASANDPHOTOGRAPHY-Video-Equipment"/>
  11600. <enumeration value="CAMERASANDPHOTOGRAPHY-Film"/>
  11601. <enumeration value="CAMERASANDPHOTOGRAPHY-Supplies"/>
  11602. <enumeration value="CLOTHING-Accessories"/>
  11603. <enumeration value="CLOTHING-Babies-Clothing-and-Supplies"/>
  11604. <enumeration value="CLOTHING-Childrens-Clothing"/>
  11605. <enumeration value="CLOTHING-Mens-Clothing"/>
  11606. <enumeration value="CLOTHING-Shoes"/>
  11607. <enumeration value="CLOTHING-Wedding-Clothing"/>
  11608. <enumeration value="CLOTHING-Womens-Clothing"/>
  11609. <enumeration value="CLOTHING-General"/>
  11610. <enumeration value="CLOTHING-Jewelry"/>
  11611. <enumeration value="CLOTHING-Watches-and-Clocks"/>
  11612. <enumeration value="CLOTHING-Rings"/>
  11613. <enumeration value="COLLECTIBLES-General"/>
  11614. <enumeration value="COLLECTIBLES-Advertising"/>
  11615. <enumeration value="COLLECTIBLES-Animals"/>
  11616. <enumeration value="COLLECTIBLES-Animation"/>
  11617. <enumeration value="COLLECTIBLES-Coin-Operated-Banks-and-Casinos"/>
  11618. <enumeration value="COLLECTIBLES-Coins-and-Paper-Money"/>
  11619. <enumeration value="COLLECTIBLES-Comics"/>
  11620. <enumeration value="COLLECTIBLES-Decorative"/>
  11621. <enumeration value="COLLECTIBLES-Disneyana"/>
  11622. <enumeration value="COLLECTIBLES-Holiday"/>
  11623. <enumeration value="COLLECTIBLES-Knives-and-Swords"/>
  11624. <enumeration value="COLLECTIBLES-Militaria"/>
  11625. <enumeration value="COLLECTIBLES-Postcards-and-Paper"/>
  11626. <enumeration value="COLLECTIBLES-Stamps"/>
  11627. <enumeration value="COMPUTERHARDWAREANDSOFTWARE-General"/>
  11628. <enumeration value="COMPUTERHARDWAREANDSOFTWARE-Desktop-PCs"/>
  11629. <enumeration value="COMPUTERHARDWAREANDSOFTWARE-Monitors"/>
  11630. <enumeration value="COMPUTERHARDWAREANDSOFTWARE-Hardware"/>
  11631. <enumeration value="COMPUTERHARDWAREANDSOFTWARE-Peripherals"/>
  11632. <enumeration value="COMPUTERHARDWAREANDSOFTWARE-Laptops-Notebooks-PDAs"/>
  11633. <enumeration value="COMPUTERHARDWAREANDSOFTWARE-Networking-Equipment"/>
  11634. <enumeration value="COMPUTERHARDWAREANDSOFTWARE-Parts-and-Accessories"/>
  11635. <enumeration value="COMPUTERHARDWAREANDSOFTWARE-GeneralSoftware"/>
  11636. <enumeration value="COMPUTERHARDWAREANDSOFTWARE-Oem-Software"/>
  11637. <enumeration value="COMPUTERHARDWAREANDSOFTWARE-Academic-Software"/>
  11638. <enumeration value="COMPUTERHARDWAREANDSOFTWARE-Beta-Software"/>
  11639. <enumeration value="COMPUTERHARDWAREANDSOFTWARE-Game-Software"/>
  11640. <enumeration value="COMPUTERHARDWAREANDSOFTWARE-Data-Processing-Svc"/>
  11641. <enumeration value="CULTUREANDRELIGION-General"/>
  11642. <enumeration value="CULTUREANDRELIGION-Christianity"/>
  11643. <enumeration value="CULTUREANDRELIGION-Metaphysical"/>
  11644. <enumeration value="CULTUREANDRELIGION-New-Age"/>
  11645. <enumeration value="CULTUREANDRELIGION-Organizations"/>
  11646. <enumeration value="CULTUREANDRELIGION-Other-Faiths"/>
  11647. <enumeration value="CULTUREANDRELIGION-Collectibles"/>
  11648. <enumeration value="ELECTRONICSANDTELECOM-GeneralTelecom"/>
  11649. <enumeration value="ELECTRONICSANDTELECOM-Cell-Phones-and-Pagers"/>
  11650. <enumeration value="ELECTRONICSANDTELECOM-Telephone-Cards"/>
  11651. <enumeration value="ELECTRONICSANDTELECOM-Telephone-Equipment"/>
  11652. <enumeration value="ELECTRONICSANDTELECOM-Telephone-Services"/>
  11653. <enumeration value="ELECTRONICSANDTELECOM-GeneralElectronics"/>
  11654. <enumeration value="ELECTRONICSANDTELECOM-Car-Audio-and-Electronics"/>
  11655. <enumeration value="ELECTRONICSANDTELECOM-Home-Electronics"/>
  11656. <enumeration value="ELECTRONICSANDTELECOM-Home-Audio"/>
  11657. <enumeration value="ELECTRONICSANDTELECOM-Gadgets-and-other-electronics"/>
  11658. <enumeration value="ELECTRONICSANDTELECOM-Batteries"/>
  11659. <enumeration value="ELECTRONICSANDTELECOM-ScannersRadios"/>
  11660. <enumeration value="ELECTRONICSANDTELECOM-Radar-Dectors"/>
  11661. <enumeration value="ELECTRONICSANDTELECOM-Radar-Jamming-Devices"/>
  11662. <enumeration value="ELECTRONICSANDTELECOM-Satellite-and-Cable-TV-Descramblers"/>
  11663. <enumeration value="ELECTRONICSANDTELECOM-Surveillance-Equipment"/>
  11664. <enumeration value="ENTERTAINMENT-General"/>
  11665. <enumeration value="ENTERTAINMENT-Movies"/>
  11666. <enumeration value="ENTERTAINMENT-Music"/>
  11667. <enumeration value="ENTERTAINMENT-Concerts"/>
  11668. <enumeration value="ENTERTAINMENT-Theater"/>
  11669. <enumeration value="ENTERTAINMENT-Bootleg-Recordings"/>
  11670. <enumeration value="ENTERTAINMENT-Promotional-Items"/>
  11671. <enumeration value="ENTERTAINMENTMEMORABILIA-General"/>
  11672. <enumeration value="ENTERTAINMENTMEMORABILIA-Autographs"/>
  11673. <enumeration value="ENTERTAINMENTMEMORABILIA-Limited-Editions"/>
  11674. <enumeration value="ENTERTAINMENTMEMORABILIA-Movie"/>
  11675. <enumeration value="ENTERTAINMENTMEMORABILIA-Music"/>
  11676. <enumeration value="ENTERTAINMENTMEMORABILIA-Novelties"/>
  11677. <enumeration value="ENTERTAINMENTMEMORABILIA-Photos"/>
  11678. <enumeration value="ENTERTAINMENTMEMORABILIA-Posters"/>
  11679. <enumeration value="ENTERTAINMENTMEMORABILIA-Sports-and-Fan-Shop"/>
  11680. <enumeration value="ENTERTAINMENTMEMORABILIA-Science-Fiction"/>
  11681. <enumeration value="FOODDRINKANDNUTRITION-General"/>
  11682. <enumeration value="FOODDRINKANDNUTRITION-Coffee-and-Tea"/>
  11683. <enumeration value="FOODDRINKANDNUTRITION-Food-Products"/>
  11684. <enumeration value="FOODDRINKANDNUTRITION-Gourmet-Items"/>
  11685. <enumeration value="FOODDRINKANDNUTRITION-Health-and-Nutrition"/>
  11686. <enumeration value="FOODDRINKANDNUTRITION-Services"/>
  11687. <enumeration value="FOODDRINKANDNUTRITION-Vitamins-and-Supplements"/>
  11688. <enumeration value="FOODDRINKANDNUTRITION-Weight-Management-and-Health-Products"/>
  11689. <enumeration value="FOODDRINKANDNUTRITION-Restaurant"/>
  11690. <enumeration value="FOODDRINKANDNUTRITION-Tobacco-and-Cigars"/>
  11691. <enumeration value="FOODDRINKANDNUTRITION-Alcoholic-Beverages"/>
  11692. <enumeration value="GIFTSANDFLOWERS-General"/>
  11693. <enumeration value="GIFTSANDFLOWERS-Flowers"/>
  11694. <enumeration value="GIFTSANDFLOWERS-Greeting-Cards"/>
  11695. <enumeration value="GIFTSANDFLOWERS-Humorous-Gifts-and-Novelties"/>
  11696. <enumeration value="GIFTSANDFLOWERS-Personalized-Gifts"/>
  11697. <enumeration value="GIFTSANDFLOWERS-Products"/>
  11698. <enumeration value="GIFTSANDFLOWERS-Services"/>
  11699. <enumeration value="HOBBIESTOYSANDGAMES-General"/>
  11700. <enumeration value="HOBBIESTOYSANDGAMES-Action-Figures"/>
  11701. <enumeration value="HOBBIESTOYSANDGAMES-Bean-Babies"/>
  11702. <enumeration value="HOBBIESTOYSANDGAMES-Barbies"/>
  11703. <enumeration value="HOBBIESTOYSANDGAMES-Bears"/>
  11704. <enumeration value="HOBBIESTOYSANDGAMES-Dolls"/>
  11705. <enumeration value="HOBBIESTOYSANDGAMES-Games"/>
  11706. <enumeration value="HOBBIESTOYSANDGAMES-Model-Kits"/>
  11707. <enumeration value="HOBBIESTOYSANDGAMES-Diecast-Toys-Vehicles"/>
  11708. <enumeration value="HOBBIESTOYSANDGAMES-Video-Games-and-Systems"/>
  11709. <enumeration value="HOBBIESTOYSANDGAMES-Vintage-and-Antique-Toys"/>
  11710. <enumeration value="HOBBIESTOYSANDGAMES-BackupUnreleased-Games"/>
  11711. <enumeration value="HOBBIESTOYSANDGAMES-Game-copying-hardwaresoftware"/>
  11712. <enumeration value="HOBBIESTOYSANDGAMES-Mod-Chips"/>
  11713. <enumeration value="HOMEANDGARDEN-General"/>
  11714. <enumeration value="HOMEANDGARDEN-Appliances"/>
  11715. <enumeration value="HOMEANDGARDEN-Bed-and-Bath"/>
  11716. <enumeration value="HOMEANDGARDEN-Furnishing-and-Decorating"/>
  11717. <enumeration value="HOMEANDGARDEN-Garden-Supplies"/>
  11718. <enumeration value="HOMEANDGARDEN-Hardware-and-Tools"/>
  11719. <enumeration value="HOMEANDGARDEN-Household-Goods"/>
  11720. <enumeration value="HOMEANDGARDEN-Kitchenware"/>
  11721. <enumeration value="HOMEANDGARDEN-Rugs-and-Carpets"/>
  11722. <enumeration value="HOMEANDGARDEN-Security-and-Home-Defense"/>
  11723. <enumeration value="HOMEANDGARDEN-Plants-and-Seeds"/>
  11724. <enumeration value="INTERNETANDNETWORKSERVICES-General"/>
  11725. <enumeration value="INTERNETANDNETWORKSERVICES-Bulletin-board"/>
  11726. <enumeration value="INTERNETANDNETWORKSERVICES-online-services"/>
  11727. <enumeration value="INTERNETANDNETWORKSERVICES-Auction-management-tools"/>
  11728. <enumeration value="INTERNETANDNETWORKSERVICES-ecommerce-development"/>
  11729. <enumeration value="INTERNETANDNETWORKSERVICES-training-services"/>
  11730. <enumeration value="INTERNETANDNETWORKSERVICES-Online-Malls"/>
  11731. <enumeration value="INTERNETANDNETWORKSERVICES-Web-hosting-and-design"/>
  11732. <enumeration value="MEDIAANDENTERTAINMENT-General"/>
  11733. <enumeration value="MEDIAANDENTERTAINMENT-Concerts"/>
  11734. <enumeration value="MEDIAANDENTERTAINMENT-Theater"/>
  11735. <enumeration value="MEDICALANDPHARMACEUTICAL-General"/>
  11736. <enumeration value="MEDICALANDPHARMACEUTICAL-Medical"/>
  11737. <enumeration value="MEDICALANDPHARMACEUTICAL-Dental"/>
  11738. <enumeration value="MEDICALANDPHARMACEUTICAL-Opthamalic"/>
  11739. <enumeration value="MEDICALANDPHARMACEUTICAL-Prescription-Drugs"/>
  11740. <enumeration value="MEDICALANDPHARMACEUTICAL-Devices"/>
  11741. <enumeration value="MONEYSERVICEBUSINESSES-General"/>
  11742. <enumeration value="MONEYSERVICEBUSINESSES-Remittance"/>
  11743. <enumeration value="MONEYSERVICEBUSINESSES-Wire-Transfer"/>
  11744. <enumeration value="MONEYSERVICEBUSINESSES-Money-Orders"/>
  11745. <enumeration value="MONEYSERVICEBUSINESSES-Electronic-Cash"/>
  11746. <enumeration value="MONEYSERVICEBUSINESSES-Currency-DealerExchange"/>
  11747. <enumeration value="MONEYSERVICEBUSINESSES-Check-Cashier"/>
  11748. <enumeration value="MONEYSERVICEBUSINESSES-Travelers-Checks"/>
  11749. <enumeration value="MONEYSERVICEBUSINESSES-Stored-Value-Cards"/>
  11750. <enumeration value="NONPROFITPOLITICALANDRELIGION-General"/>
  11751. <enumeration value="NONPROFITPOLITICALANDRELIGION-Charities"/>
  11752. <enumeration value="NONPROFITPOLITICALANDRELIGION-Political"/>
  11753. <enumeration value="NONPROFITPOLITICALANDRELIGION-Religious"/>
  11754. <enumeration value="PETSANDANIMALS-General"/>
  11755. <enumeration value="PETSANDANIMALS-Supplies-and-Toys"/>
  11756. <enumeration value="PETSANDANIMALS-Wildlife-Products"/>
  11757. <enumeration value="REALESTATE-General"/>
  11758. <enumeration value="REALESTATE-Commercial"/>
  11759. <enumeration value="REALESTATE-Residential"/>
  11760. <enumeration value="REALESTATE-Time-Shares"/>
  11761. <enumeration value="SERVICES-GeneralGovernment"/>
  11762. <enumeration value="SERVICES-Legal"/>
  11763. <enumeration value="SERVICES-Medical"/>
  11764. <enumeration value="SERVICES-Dental"/>
  11765. <enumeration value="SERVICES-Vision"/>
  11766. <enumeration value="SERVICES-General"/>
  11767. <enumeration value="SERVICES-Child-Care-Services"/>
  11768. <enumeration value="SERVICES-Consulting"/>
  11769. <enumeration value="SERVICES-ImportingExporting"/>
  11770. <enumeration value="SERVICES-InsuranceDirect"/>
  11771. <enumeration value="SERVICES-Financial-Services"/>
  11772. <enumeration value="SERVICES-Graphic-and-Commercial-Design"/>
  11773. <enumeration value="SERVICES-Landscaping"/>
  11774. <enumeration value="SERVICES-Locksmith"/>
  11775. <enumeration value="SERVICES-Online-Dating"/>
  11776. <enumeration value="SERVICES-Event-and-Wedding-Planning"/>
  11777. <enumeration value="SERVICES-Schools-and-Colleges"/>
  11778. <enumeration value="SERVICES-Entertainment"/>
  11779. <enumeration value="SERVICES-Aggregators"/>
  11780. <enumeration value="SPORTSANDRECREATION-General"/>
  11781. <enumeration value="SPORTSANDRECREATION-Bicycles-and-Accessories"/>
  11782. <enumeration value="SPORTSANDRECREATION-Boating-Sailing-and-Accessories"/>
  11783. <enumeration value="SPORTSANDRECREATION-Camping-and-Survival"/>
  11784. <enumeration value="SPORTSANDRECREATION-Exercise-Equipment"/>
  11785. <enumeration value="SPORTSANDRECREATION-Fishing"/>
  11786. <enumeration value="SPORTSANDRECREATION-Golf"/>
  11787. <enumeration value="SPORTSANDRECREATION-Hunting"/>
  11788. <enumeration value="SPORTSANDRECREATION-Paintball"/>
  11789. <enumeration value="SPORTSANDRECREATION-Sporting-Goods"/>
  11790. <enumeration value="SPORTSANDRECREATION-Swimming-Pools-and-Spas"/>
  11791. <enumeration value="TRAVEL-General"/>
  11792. <enumeration value="TRAVEL-Accommodations"/>
  11793. <enumeration value="TRAVEL-Agencies"/>
  11794. <enumeration value="TRAVEL-Airlines"/>
  11795. <enumeration value="TRAVEL-Auto-Rentals"/>
  11796. <enumeration value="TRAVEL-Cruises"/>
  11797. <enumeration value="TRAVEL-Other-Transportation"/>
  11798. <enumeration value="TRAVEL-Services"/>
  11799. <enumeration value="TRAVEL-Supplies"/>
  11800. <enumeration value="TRAVEL-Tours"/>
  11801. <enumeration value="TRAVEL-AirlinesSpirit-Air"/>
  11802. <enumeration value="Other-SubCategories"/>
  11803. </restriction>
  11804. </simpleType>
  11805. <simpleType name="AverageTransactionPriceType">
  11806. <annotation>
  11807. <documentation>
  11808. AverageTransactionPriceType
  11809. <br/>
  11810. <br/>
  11811. <table>
  11812. <tr>
  11813. <th>Enumeration</th>
  11814. <th>Meaning</th>
  11815. </tr>
  11816. <tr>
  11817. <td/>
  11818. <td/>
  11819. </tr>AverageTransactionPrice-Not-Applicable
  11820. <tr>
  11821. <td>AverageTransactionPrice-Range1</td>
  11822. <td>Less than $25 USD</td>
  11823. </tr>
  11824. <tr>
  11825. <td>AverageTransactionPrice-Range2</td>
  11826. <td>$25 USD to $50 USD</td>
  11827. </tr>
  11828. <tr>
  11829. <td>AverageTransactionPrice-Range3</td>
  11830. <td>$50 USD to $100 USD</td>
  11831. </tr>
  11832. <tr>
  11833. <td>AverageTransactionPrice-Range4</td>
  11834. <td>$100 USD to $250 USD</td>
  11835. </tr>
  11836. <tr>
  11837. <td>AverageTransactionPrice-Range5</td>
  11838. <td>$250 USD to $500 USD</td>
  11839. </tr>
  11840. <tr>
  11841. <td>AverageTransactionPrice-Range6</td>
  11842. <td>$500 USD to $1,000 USD</td>
  11843. </tr>
  11844. <tr>
  11845. <td>AverageTransactionPrice-Range7</td>
  11846. <td> $1,000 USD to $2,000 USD</td>
  11847. </tr>
  11848. <tr>
  11849. <td>AverageTransactionPrice-Range8</td>
  11850. <td>$2,000 USD to $5,000 USD</td>
  11851. </tr>
  11852. <tr>
  11853. <td>AverageTransactionPrice-Range9</td>
  11854. <td>$5,000 USD to $10,000 USD</td>
  11855. </tr>
  11856. <tr>
  11857. <td>AverageTransactionPrice-Range10</td>
  11858. <td>More than $10,000 USD</td>
  11859. </tr>
  11860. </table>
  11861. </documentation>
  11862. </annotation>
  11863. <restriction base="xs:token">
  11864. <enumeration value="AverageTransactionPrice-Not-Applicable"/>
  11865. <enumeration value="AverageTransactionPrice-Range1"/>
  11866. <enumeration value="AverageTransactionPrice-Range2"/>
  11867. <enumeration value="AverageTransactionPrice-Range3"/>
  11868. <enumeration value="AverageTransactionPrice-Range4"/>
  11869. <enumeration value="AverageTransactionPrice-Range5"/>
  11870. <enumeration value="AverageTransactionPrice-Range6"/>
  11871. <enumeration value="AverageTransactionPrice-Range7"/>
  11872. <enumeration value="AverageTransactionPrice-Range8"/>
  11873. <enumeration value="AverageTransactionPrice-Range9"/>
  11874. <enumeration value="AverageTransactionPrice-Range10"/>
  11875. </restriction>
  11876. </simpleType>
  11877. <simpleType name="AverageMonthlyVolumeType">
  11878. <annotation>
  11879. <documentation>
  11880. AverageMonthlyVolumeType
  11881. <table>
  11882. <tr>
  11883. <th>Enumeration</th>
  11884. <th>Meaning</th>
  11885. </tr>
  11886. <tr>
  11887. <td>AverageMonthlyVolume-Not-Applicable</td>
  11888. <td/>
  11889. </tr>
  11890. <tr>
  11891. <td>AverageMonthlyVolume-Range1</td>
  11892. <td>Less than $1,000 USD</td>
  11893. </tr>
  11894. <tr>
  11895. <td>AverageMonthlyVolume-Range2</td>
  11896. <td>$1,000 USD to $5,000 USD</td>
  11897. </tr>
  11898. <tr>
  11899. <td>AverageMonthlyVolume-Range3</td>
  11900. <td>$5,000 USD to $25,000 USD</td>
  11901. </tr>
  11902. <tr>
  11903. <td>AverageMonthlyVolume-Range4</td>
  11904. <td>$25,000 USD to $100,000 USD</td>
  11905. </tr>
  11906. <tr>
  11907. <td>AverageMonthlyVolume-Range5</td>
  11908. <td>$100,000 USD to $1,000,000 USD</td>
  11909. </tr>
  11910. <tr>
  11911. <td>AverageMonthlyVolume-Range6</td>
  11912. <td>More than $1,000,000 USD</td>
  11913. </tr>
  11914. </table>
  11915. </documentation>
  11916. </annotation>
  11917. <restriction base="xs:token">
  11918. <enumeration value="AverageMonthlyVolume-Not-Applicable"/>
  11919. <enumeration value="AverageMonthlyVolume-Range1"/>
  11920. <enumeration value="AverageMonthlyVolume-Range2"/>
  11921. <enumeration value="AverageMonthlyVolume-Range3"/>
  11922. <enumeration value="AverageMonthlyVolume-Range4"/>
  11923. <enumeration value="AverageMonthlyVolume-Range5"/>
  11924. <enumeration value="AverageMonthlyVolume-Range6"/>
  11925. </restriction>
  11926. </simpleType>
  11927. <simpleType name="SalesVenueType">
  11928. <annotation>
  11929. <documentation>
  11930. SalesVenueType
  11931. </documentation>
  11932. </annotation>
  11933. <restriction base="xs:token">
  11934. <enumeration value="Venue-Unspecified"/>
  11935. <enumeration value="eBay"/>
  11936. <enumeration value="AnotherMarketPlace"/>
  11937. <enumeration value="OwnWebsite"/>
  11938. <enumeration value="Other"/>
  11939. </restriction>
  11940. </simpleType>
  11941. <simpleType name="PercentageRevenueFromOnlineSalesType">
  11942. <annotation>
  11943. <documentation>
  11944. PercentageRevenueFromOnlineSalesType
  11945. <br/>
  11946. <br/>
  11947. <table>
  11948. <tr>
  11949. <th>Enumeration</th>
  11950. <th>Meaning</th>
  11951. </tr>
  11952. <tr>
  11953. <td/>
  11954. <td/>
  11955. </tr>PercentageRevenueFromOnlineSales-Not-Applicable
  11956. <tr>
  11957. <td>PercentageRevenueFromOnlineSales-Range1</td>
  11958. <td>Less than 25%</td>
  11959. </tr>
  11960. <tr>
  11961. <td>PercentageRevenueFromOnlineSales-Range2</td>
  11962. <td>25% to 50%</td>
  11963. </tr>
  11964. <tr>
  11965. <td>PercentageRevenueFromOnlineSales-Range3</td>
  11966. <td>50% to 75%</td>
  11967. </tr>
  11968. <tr>
  11969. <td>PercentageRevenueFromOnlineSales-Range4</td>
  11970. <td>75% to 100%</td>
  11971. </tr>
  11972. </table>
  11973. </documentation>
  11974. </annotation>
  11975. <restriction base="xs:token">
  11976. <enumeration value="PercentageRevenueFromOnlineSales-Not-Applicable"/>
  11977. <enumeration value="PercentageRevenueFromOnlineSales-Range1"/>
  11978. <enumeration value="PercentageRevenueFromOnlineSales-Range2"/>
  11979. <enumeration value="PercentageRevenueFromOnlineSales-Range3"/>
  11980. <enumeration value="PercentageRevenueFromOnlineSales-Range4"/>
  11981. </restriction>
  11982. </simpleType>
  11983. <complexType name="BusinessOwnerInfoType">
  11984. <annotation>
  11985. <documentation>
  11986. BusinessOwnerInfoType
  11987. </documentation>
  11988. </annotation>
  11989. <sequence>
  11990. <element name="Owner" type="ns:PayerInfoType" minOccurs="0">
  11991. <annotation>
  11992. <documentation>
  11993. Details about the business owner</documentation>
  11994. </annotation>
  11995. </element>
  11996. <element name="HomePhone" type="xs:string" minOccurs="0">
  11997. <annotation>
  11998. <documentation>
  11999. Business owner’s home telephone number
  12000. <br/>
  12001. <br/>Character length and limitations: 32 alphanumeric characters</documentation>
  12002. </annotation>
  12003. </element>
  12004. <element name="MobilePhone" type="xs:string" minOccurs="0">
  12005. <annotation>
  12006. <documentation>
  12007. Business owner’s mobile telephone number
  12008. <br/>
  12009. <br/>
  12010. Character length and limitations: 32 alphanumeric characters</documentation>
  12011. </annotation>
  12012. </element>
  12013. <element name="SSN" type="xs:string" minOccurs="0">
  12014. <annotation>
  12015. <documentation>
  12016. Business owner’s social security number
  12017. <br/>
  12018. <br/>
  12019. Character length and limitations: 9 alphanumeric characters</documentation>
  12020. </annotation>
  12021. </element>
  12022. </sequence>
  12023. </complexType>
  12024. <complexType name="BankAccountDetailsType">
  12025. <annotation>
  12026. <documentation>
  12027. BankAccountDetailsType
  12028. </documentation>
  12029. </annotation>
  12030. <sequence>
  12031. <element name="Name" type="xs:string">
  12032. <annotation>
  12033. <documentation>
  12034. Name of bank
  12035. <br/>
  12036. <br/>
  12037. Character length and limitations: 192 alphanumeric characters</documentation>
  12038. </annotation>
  12039. </element>
  12040. <element name="Type" type="ns:BankAccountTypeType">
  12041. <annotation>
  12042. <documentation>
  12043. Type of bank account: Checking or Savings</documentation>
  12044. </annotation>
  12045. </element>
  12046. <element name="RoutingNumber" type="xs:string">
  12047. <annotation>
  12048. <documentation>
  12049. Merchant’s bank routing number
  12050. <br/>
  12051. <br/>
  12052. Character length and limitations: 23 alphanumeric characters</documentation>
  12053. </annotation>
  12054. </element>
  12055. <element name="AccountNumber" type="xs:string">
  12056. <annotation>
  12057. <documentation>
  12058. Merchant’s bank account number
  12059. <br/>
  12060. <br/>
  12061. Character length and limitations: 256 alphanumeric characters</documentation>
  12062. </annotation>
  12063. </element>
  12064. </sequence>
  12065. </complexType>
  12066. <simpleType name="BankAccountTypeType">
  12067. <annotation>
  12068. <documentation>
  12069. BankAccountTypeType
  12070. </documentation>
  12071. </annotation>
  12072. <restriction base="xs:token">
  12073. <enumeration value="Checking"/>
  12074. <enumeration value="Savings"/>
  12075. </restriction>
  12076. </simpleType>
  12077. <simpleType name="EnterBoardingTokenType">
  12078. <restriction base="xs:string"/>
  12079. </simpleType>
  12080. <complexType name="GetBoardingDetailsResponseDetailsType">
  12081. <sequence>
  12082. <element name="Status" type="ns:BoardingStatusType">
  12083. <annotation>
  12084. <documentation>
  12085. Status of merchant's onboarding process:
  12086. <br/>
  12087. <br/>
  12088. Completed
  12089. <br/>Cancelled
  12090. <br/>Pending
  12091. <br/>
  12092. <br/>Character length and limitations: Eight alphabetic characters</documentation>
  12093. </annotation>
  12094. </element>
  12095. <element name="StartDate" type="xs:dateTime">
  12096. <annotation>
  12097. <documentation>
  12098. Date the boarding process started</documentation>
  12099. </annotation>
  12100. </element>
  12101. <element name="LastUpdated" type="xs:dateTime">
  12102. <annotation>
  12103. <documentation>
  12104. Date the merchant’s status or progress was last updated</documentation>
  12105. </annotation>
  12106. </element>
  12107. <element name="Reason" type="xs:string" minOccurs="0">
  12108. <annotation>
  12109. <documentation>
  12110. Reason for merchant’s cancellation of sign-up.
  12111. <br/>
  12112. <br/>
  12113. Character length and limitations: 1,024 alphanumeric characters</documentation>
  12114. </annotation>
  12115. </element>
  12116. <element name="ProgramName" type="xs:string"/>
  12117. <element name="ProgramCode" type="xs:string"/>
  12118. <element name="CampaignID" type="xs:string" minOccurs="0"/>
  12119. <element name="UserWithdrawalLimit" type="ns:UserWithdrawalLimitTypeType" minOccurs="0">
  12120. <annotation>
  12121. <documentation>
  12122. Indicates if there is a limitation on the amount of money the business can withdraw from PayPal</documentation>
  12123. </annotation>
  12124. </element>
  12125. <element name="PartnerCustom" type="xs:string" minOccurs="0">
  12126. <annotation>
  12127. <documentation>
  12128. Custom information you set on the EnterBoarding API call
  12129. <br/>
  12130. <br/>Character length and limitations: 256 alphanumeric characters</documentation>
  12131. </annotation>
  12132. </element>
  12133. <element name="AccountOwner" type="ns:PayerInfoType" minOccurs="0">
  12134. <annotation>
  12135. <documentation>
  12136. Details about the owner of the account</documentation>
  12137. </annotation>
  12138. </element>
  12139. <element name="Credentials" type="ns:APICredentialsType" minOccurs="0">
  12140. <annotation>
  12141. <documentation>
  12142. Merchant’s PayPal API credentials</documentation>
  12143. </annotation>
  12144. </element>
  12145. <element name="ConfigureAPIs" type="xs:string" minOccurs="0">
  12146. <annotation>
  12147. <documentation>
  12148. The APIs that this merchant has granted the business partner permission to call on his behalf.
  12149. <br/>
  12150. <br/>
  12151. For example:
  12152. <br/>
  12153. SetExpressCheckout,GetExpressCheckoutDetails,DoExpressCheckoutPayment
  12154. </documentation>
  12155. </annotation>
  12156. </element>
  12157. <element name="EmailVerificationStatus" type="xs:string" minOccurs="0">
  12158. <annotation>
  12159. <documentation>
  12160. Primary email verification status. Confirmed, Unconfirmed</documentation>
  12161. </annotation>
  12162. </element>
  12163. <element name="VettingStatus" type="xs:string" minOccurs="0">
  12164. <annotation>
  12165. <documentation>
  12166. Gives VettingStatus - Pending, Cancelled, Approved, UnderReview
  12167. <br/>
  12168. <br/>Character length and limitations: 256 alphanumeric characters</documentation>
  12169. </annotation>
  12170. </element>
  12171. <element name="BankAccountVerificationStatus" type="xs:string" minOccurs="0">
  12172. <annotation>
  12173. <documentation>
  12174. Gives BankAccountVerificationStatus - Added, Confirmed
  12175. <br/>
  12176. <br/>Character length and limitations: 256 alphanumeric characters</documentation>
  12177. </annotation>
  12178. </element>
  12179. </sequence>
  12180. </complexType>
  12181. <simpleType name="BoardingStatusType">
  12182. <annotation>
  12183. <documentation>
  12184. Boarding Status
  12185. </documentation>
  12186. </annotation>
  12187. <restriction base="xs:token">
  12188. <enumeration value="Unknown"/>
  12189. <enumeration value="Completed"/>
  12190. <enumeration value="Cancelled"/>
  12191. <enumeration value="Pending"/>
  12192. </restriction>
  12193. </simpleType>
  12194. <simpleType name="UserWithdrawalLimitTypeType">
  12195. <annotation>
  12196. <documentation>
  12197. User Withdrawal Limit Type Type
  12198. </documentation>
  12199. </annotation>
  12200. <restriction base="xs:token">
  12201. <enumeration value="Unknown"/>
  12202. <enumeration value="Limited"/>
  12203. <enumeration value="Unlimited"/>
  12204. </restriction>
  12205. </simpleType>
  12206. <complexType name="APICredentialsType">
  12207. <annotation>
  12208. <documentation>
  12209. APICredentialsType
  12210. </documentation>
  12211. </annotation>
  12212. <sequence>
  12213. <element name="Username" type="xs:string">
  12214. <annotation>
  12215. <documentation>
  12216. Merchant’s PayPal API username
  12217. Character length and limitations: 128 alphanumeric characters</documentation>
  12218. </annotation>
  12219. </element>
  12220. <element name="Password" type="xs:string">
  12221. <annotation>
  12222. <documentation>
  12223. Merchant’s PayPal API password
  12224. Character length and limitations: 40 alphanumeric characters</documentation>
  12225. </annotation>
  12226. </element>
  12227. <element name="Signature" type="xs:string" minOccurs="0">
  12228. <annotation>
  12229. <documentation>
  12230. Merchant’s PayPal API signature, if one exists.
  12231. <br/>
  12232. <br/>Character length and limitations: 256 alphanumeric characters</documentation>
  12233. </annotation>
  12234. </element>
  12235. <element name="Certificate" type="xs:string" minOccurs="0">
  12236. <annotation>
  12237. <documentation>
  12238. Merchant’s PayPal API certificate in PEM format, if one exists
  12239. <br/>
  12240. <br/>
  12241. The certificate consists of two parts: the private key (2,048 bytes) and the certificate proper (4,000 bytes).
  12242. <br/>
  12243. <br/>
  12244. <br/>Character length and limitations: 6,048 alphanumeric characters</documentation>
  12245. </annotation>
  12246. </element>
  12247. <element name="Type" type="ns:APIAuthenticationType">
  12248. <annotation>
  12249. <documentation>
  12250. Merchant’s PayPal API authentication mechanism.
  12251. <br/>
  12252. <br/>
  12253. Auth-None: no authentication mechanism on file
  12254. <br/>
  12255. <br/>Cert: API certificate
  12256. <br/>
  12257. <br/>Sign: API signature
  12258. <br/>
  12259. <br/>Character length and limitations: 9 alphanumeric characters</documentation>
  12260. </annotation>
  12261. </element>
  12262. </sequence>
  12263. </complexType>
  12264. <simpleType name="APIAuthenticationType">
  12265. <annotation>
  12266. <documentation>
  12267. API Authentication Type
  12268. </documentation>
  12269. </annotation>
  12270. <restriction base="xs:token">
  12271. <enumeration value="Auth-None"/>
  12272. <enumeration value="Cert"/>
  12273. <enumeration value="Sign"/>
  12274. </restriction>
  12275. </simpleType>
  12276. <element name="SetMobileCheckoutRequestDetails" type="ns:SetMobileCheckoutRequestDetailsType"/>
  12277. <complexType name="SetMobileCheckoutRequestDetailsType">
  12278. <sequence>
  12279. <element name="BuyerPhone" type="ns:PhoneNumberType" minOccurs="0">
  12280. <annotation>
  12281. <documentation>The phone number of the buyer's mobile device, if available.
  12282. <br/>
  12283. <br/>
  12284. <b>Optional</b>
  12285. <br/>
  12286. </documentation>
  12287. </annotation>
  12288. </element>
  12289. <element name="ItemAmount" type="cc:BasicAmountType" minOccurs="1">
  12290. <annotation>
  12291. <documentation>
  12292. Cost of this item before tax and shipping.
  12293. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.
  12294. <br/>
  12295. <br/>
  12296. Required
  12297. <br/>
  12298. </documentation>
  12299. </annotation>
  12300. </element>
  12301. <element name="Tax" type="cc:BasicAmountType" minOccurs="0">
  12302. <annotation>
  12303. <documentation>
  12304. Tax amount for this item.
  12305. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.
  12306. <br/>
  12307. <br/>
  12308. Optional
  12309. <br/>
  12310. </documentation>
  12311. </annotation>
  12312. </element>
  12313. <element name="Shipping" type="cc:BasicAmountType" minOccurs="0">
  12314. <annotation>
  12315. <documentation>
  12316. Shipping amount for this item.
  12317. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.
  12318. <br/>
  12319. <br/>
  12320. Optional
  12321. <br/>
  12322. </documentation>
  12323. </annotation>
  12324. </element>
  12325. <element name="ItemName" type="xs:string" minOccurs="1">
  12326. <annotation>
  12327. <documentation>Description of the item that the customer is purchasing.
  12328. <br/>
  12329. <br/>
  12330. Required
  12331. <br/>
  12332. <br/>Character length and limitations: 127 single-byte alphanumeric characters
  12333. </documentation>
  12334. </annotation>
  12335. </element>
  12336. <element name="ItemNumber" type="xs:string" minOccurs="0">
  12337. <annotation>
  12338. <documentation>Reference number of the item that the customer is purchasing.
  12339. <br/>
  12340. <br/>
  12341. Optional
  12342. <br/>
  12343. <br/>Character length and limitations: 127 single-byte alphanumeric characters
  12344. </documentation>
  12345. </annotation>
  12346. </element>
  12347. <element name="Custom" type="xs:string" minOccurs="0">
  12348. <annotation>
  12349. <documentation>A free-form field for your own use, such as a tracking number or other value you want returned to you in IPN.
  12350. <br/>
  12351. <br/>
  12352. Optional
  12353. <br/>
  12354. <br/>Character length and limitations: 256 single-byte alphanumeric characters
  12355. </documentation>
  12356. </annotation>
  12357. </element>
  12358. <element name="InvoiceID" type="xs:string" minOccurs="0">
  12359. <annotation>
  12360. <documentation>Your own unique invoice or tracking number.
  12361. <br/>
  12362. <br/>
  12363. Optional
  12364. <br/>
  12365. <br/>Character length and limitations: 127 single-byte alphanumeric characters
  12366. </documentation>
  12367. </annotation>
  12368. </element>
  12369. <element name="ReturnURL" type="xs:string" minOccurs="1">
  12370. <annotation>
  12371. <documentation>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.
  12372. <br/>
  12373. <br/>
  12374. <b>Required</b>
  12375. <br/>
  12376. <br/>
  12377. Character length and limitations: no limit. </documentation>
  12378. </annotation>
  12379. </element>
  12380. <element name="CancelURL" type="xs:string" minOccurs="0">
  12381. <annotation>
  12382. <documentation>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.
  12383. <br/>
  12384. <br/>
  12385. <b>Optional</b>
  12386. <br/>
  12387. <br/>
  12388. Character length and limitations: no limit
  12389. </documentation>
  12390. </annotation>
  12391. </element>
  12392. <element name="AddressDisplayOptions" type="xs:int" minOccurs="0">
  12393. <annotation>
  12394. <documentation>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.
  12395. <br/>
  12396. <br/>
  12397. Optional
  12398. <br/>
  12399. </documentation>
  12400. </annotation>
  12401. </element>
  12402. <element name="SharePhone" type="xs:int" minOccurs="0">
  12403. <annotation>
  12404. <documentation>The value 1 indicates that you require that the customer specifies a contact phone for the transactxion. Default is 0 / none required.
  12405. <br/>
  12406. <br/>
  12407. Optional
  12408. </documentation>
  12409. </annotation>
  12410. </element>
  12411. <element name="ShipToAddress" type="ns:AddressType" minOccurs="0">
  12412. <annotation>
  12413. <documentation>Customer's shipping address.
  12414. <br/>
  12415. <br/>
  12416. Optional
  12417. <br/>
  12418. </documentation>
  12419. </annotation>
  12420. </element>
  12421. <element name="BuyerEmail" type="ns:EmailAddressType" minOccurs="0">
  12422. <annotation>
  12423. <documentation>
  12424. Email address of the buyer as entered during checkout. PayPal uses this value to pre-fill the login portion of the PayPal login page.
  12425. <br/>
  12426. <br/>
  12427. Optional
  12428. <br/>
  12429. <br/>Character length and limit: 127 single-byte alphanumeric characters
  12430. </documentation>
  12431. </annotation>
  12432. </element>
  12433. </sequence>
  12434. </complexType>
  12435. <element name="DoMobileCheckoutPaymentResponseDetails" type="ns:DoMobileCheckoutPaymentResponseDetailsType"/>
  12436. <complexType name="DoMobileCheckoutPaymentResponseDetailsType">
  12437. <sequence>
  12438. <element name="Custom" type="xs:string" minOccurs="0">
  12439. <annotation>
  12440. <documentation>A free-form field for your own use, such as a tracking number or other value you want returned to you in IPN.
  12441. <br/>
  12442. <br/>
  12443. Optional
  12444. <br/>
  12445. <br/>Character length and limitations: 256 single-byte alphanumeric characters
  12446. </documentation>
  12447. </annotation>
  12448. </element>
  12449. <element name="InvoiceID" type="xs:string" minOccurs="0">
  12450. <annotation>
  12451. <documentation>Your own unique invoice or tracking number.
  12452. <br/>
  12453. <br/>
  12454. Optional
  12455. <br/>
  12456. <br/>Character length and limitations: 127 single-byte alphanumeric characters
  12457. </documentation>
  12458. </annotation>
  12459. </element>
  12460. <element name="PayerInfo" type="ns:PayerInfoType">
  12461. <annotation>
  12462. <documentation>Information about the payer</documentation>
  12463. </annotation>
  12464. </element>
  12465. <element name="PaymentInfo" type="ns:PaymentInfoType">
  12466. <annotation>
  12467. <documentation>Information about the transaction</documentation>
  12468. </annotation>
  12469. </element>
  12470. </sequence>
  12471. </complexType>
  12472. <xs:simpleType name="EbayCheckoutType">
  12473. <restriction base="xs:token">
  12474. <enumeration value="none"/>
  12475. <enumeration value="Auction"/>
  12476. <enumeration value="BuyItNow"/>
  12477. <enumeration value="FixedPriceItem"/>
  12478. <enumeration value="Autopay"/>
  12479. </restriction>
  12480. </xs:simpleType>
  12481. <xs:simpleType name="DyneticClientType">
  12482. <restriction base="xs:token">
  12483. <enumeration value="none"/>
  12484. <enumeration value="WAP"/>
  12485. <enumeration value="J2MEClient"/>
  12486. </restriction>
  12487. </xs:simpleType>
  12488. <element name="SetEbayMobileCheckoutRequestDetails" type="ns:SetEbayMobileCheckoutRequestDetailsType"/>
  12489. <complexType name="SetEbayMobileCheckoutRequestDetailsType">
  12490. <sequence>
  12491. <element name="CheckoutType" type="ns:EbayCheckoutType" minOccurs="1">
  12492. <annotation>
  12493. <documentation>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.
  12494. <br/>
  12495. <br/>
  12496. Required
  12497. <br/>
  12498. </documentation>
  12499. </annotation>
  12500. </element>
  12501. <element name="ItemId" type="xs:string" minOccurs="1">
  12502. <annotation>
  12503. <documentation>An item number assigned to the item in eBay database.
  12504. <br/>
  12505. <br/>
  12506. Required
  12507. <br/>
  12508. <br/>Character length and limitations: 127 single-byte alphanumeric characters
  12509. </documentation>
  12510. </annotation>
  12511. </element>
  12512. <element name="TransactionId" type="xs:string" minOccurs="1">
  12513. <annotation>
  12514. <documentation>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.
  12515. <br/>
  12516. <br/>
  12517. Required
  12518. <br/>
  12519. <br/>Character length and limitations: 127 single-byte alphanumeric characters
  12520. </documentation>
  12521. </annotation>
  12522. </element>
  12523. <element name="SiteId" type="xs:string" minOccurs="1">
  12524. <annotation>
  12525. <documentation>An id indicating the site on which the item was listed.
  12526. <br/>
  12527. <br/>
  12528. Required
  12529. <br/>
  12530. <br/>Character length and limitations: 2 alphanumeric characters
  12531. </documentation>
  12532. </annotation>
  12533. </element>
  12534. <element name="BuyerId" type="xs:string" minOccurs="1">
  12535. <annotation>
  12536. <documentation>Buyers ebay Id.
  12537. <br/>
  12538. <br/>
  12539. Required
  12540. <br/>
  12541. <br/>Character length and limitations: 127 single-byte alphanumeric characters
  12542. </documentation>
  12543. </annotation>
  12544. </element>
  12545. <element name="ClientType" type="ns:DyneticClientType" minOccurs="1">
  12546. <annotation>
  12547. <documentation>Indicating the client type. Weather it is WAP or J2ME. A value of 'WAP' indicates WAP. A value of 'J2MEClient' indicates J2ME client.
  12548. <br/>
  12549. <br/>
  12550. Required
  12551. <br/>
  12552. </documentation>
  12553. </annotation>
  12554. </element>
  12555. <element name="BuyerPhone" type="ns:PhoneNumberType" minOccurs="0">
  12556. <annotation>
  12557. <documentation>The phone number of the buyer's mobile device, if available.
  12558. <br/>
  12559. <br/>
  12560. <b>Optional</b>
  12561. <br/>
  12562. </documentation>
  12563. </annotation>
  12564. </element>
  12565. <element name="ReturnURL" type="xs:string" minOccurs="0">
  12566. <annotation>
  12567. <documentation>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.
  12568. <br/>
  12569. <br/>
  12570. <b>Optional</b>
  12571. <br/>
  12572. <br/>
  12573. Character length and limitations: no limit.
  12574. </documentation>
  12575. </annotation>
  12576. </element>
  12577. <element name="CancelURL" type="xs:string" minOccurs="0">
  12578. <annotation>
  12579. <documentation>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.
  12580. <br/>
  12581. <br/>
  12582. <b>Optional</b>
  12583. <br/>
  12584. <br/>
  12585. Character length and limitations: no limit
  12586. </documentation>
  12587. </annotation>
  12588. </element>
  12589. <element name="Quantity" type="xs:int" minOccurs="0">
  12590. <annotation>
  12591. <documentation>Specify quantity in case it is an immediate pay (or autopay) item.
  12592. <br/>
  12593. <br/>
  12594. Optional
  12595. <br/>
  12596. </documentation>
  12597. </annotation>
  12598. </element>
  12599. <element name="ItemAmount" type="cc:BasicAmountType" minOccurs="0">
  12600. <annotation>
  12601. <documentation>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.
  12602. <br/>
  12603. <br/>
  12604. Optional
  12605. <br/>
  12606. </documentation>
  12607. </annotation>
  12608. </element>
  12609. </sequence>
  12610. </complexType>
  12611. <complexType name="UATPDetailsType">
  12612. <annotation>
  12613. <documentation>
  12614. UATP Card Details Type
  12615. </documentation>
  12616. </annotation>
  12617. <sequence>
  12618. <element name="UATPNumber" type="xs:string">
  12619. <annotation>
  12620. <documentation>UATP Card Number</documentation>
  12621. </annotation>
  12622. </element>
  12623. <element name="ExpMonth" type="xs:int">
  12624. <annotation>
  12625. <documentation> UATP Card expirty month</documentation>
  12626. </annotation>
  12627. </element>
  12628. <element name="ExpYear" type="xs:int">
  12629. <annotation>
  12630. <documentation> UATP Card expirty year</documentation>
  12631. </annotation>
  12632. </element>
  12633. </sequence>
  12634. </complexType>
  12635. <simpleType name="RecurringPaymentsProfileStatusType">
  12636. <annotation>
  12637. <documentation>
  12638. </documentation>
  12639. </annotation>
  12640. <restriction base="xs:token">
  12641. <enumeration value="ActiveProfile"/>
  12642. <enumeration value="PendingProfile"/>
  12643. <enumeration value="CancelledProfile"/>
  12644. <enumeration value="ExpiredProfile"/>
  12645. <enumeration value="SuspendedProfile"/>
  12646. </restriction>
  12647. </simpleType>
  12648. <simpleType name="FailedPaymentActionType">
  12649. <annotation>
  12650. <documentation>
  12651. </documentation>
  12652. </annotation>
  12653. <restriction base="xs:token">
  12654. <enumeration value="CancelOnFailure"/>
  12655. <enumeration value="ContinueOnFailure"/>
  12656. </restriction>
  12657. </simpleType>
  12658. <simpleType name="AutoBillType">
  12659. <annotation>
  12660. <documentation>
  12661. </documentation>
  12662. </annotation>
  12663. <restriction base="xs:token">
  12664. <enumeration value="NoAutoBill"/>
  12665. <enumeration value="AddToNextBilling"/>
  12666. </restriction>
  12667. </simpleType>
  12668. <simpleType name="StatusChangeActionType">
  12669. <annotation>
  12670. <documentation>
  12671. </documentation>
  12672. </annotation>
  12673. <restriction base="xs:token">
  12674. <enumeration value="Cancel"/>
  12675. <enumeration value="Suspend"/>
  12676. <enumeration value="Reactivate"/>
  12677. </restriction>
  12678. </simpleType>
  12679. <complexType name="RecurringPaymentsSummaryType">
  12680. <sequence>
  12681. <element name="NextBillingDate" type="xs:dateTime" minOccurs="0" maxOccurs="1">
  12682. <annotation>
  12683. <documentation>
  12684. </documentation>
  12685. </annotation>
  12686. </element>
  12687. <element name="NumberCyclesCompleted" type="xs:int" minOccurs="1" maxOccurs="1">
  12688. <annotation>
  12689. <documentation>
  12690. </documentation>
  12691. </annotation>
  12692. </element>
  12693. <element name="NumberCyclesRemaining" type="xs:int" minOccurs="1" maxOccurs="1">
  12694. <annotation>
  12695. <documentation>
  12696. </documentation>
  12697. </annotation>
  12698. </element>
  12699. <element name="OutstandingBalance" type="cc:BasicAmountType" minOccurs="1" maxOccurs="1">
  12700. <annotation>
  12701. <documentation>
  12702. </documentation>
  12703. </annotation>
  12704. </element>
  12705. <element name="FailedPaymentCount" type="xs:int" minOccurs="1" maxOccurs="1">
  12706. <annotation>
  12707. <documentation>
  12708. </documentation>
  12709. </annotation>
  12710. </element>
  12711. <element name="LastPaymentDate" type="xs:dateTime" minOccurs="0" maxOccurs="1">
  12712. <annotation>
  12713. <documentation>
  12714. </documentation>
  12715. </annotation>
  12716. </element>
  12717. <element name="LastPaymentAmount" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  12718. <annotation>
  12719. <documentation>
  12720. </documentation>
  12721. </annotation>
  12722. </element>
  12723. </sequence>
  12724. </complexType>
  12725. <complexType name="ActivationDetailsType">
  12726. <sequence>
  12727. <element name="InitialAmount" type="cc:BasicAmountType" minOccurs="1" maxOccurs="1">
  12728. <annotation>
  12729. <documentation>
  12730. </documentation>
  12731. </annotation>
  12732. </element>
  12733. <element name="FailedInitialAmountAction" type="ns:FailedPaymentActionType" minOccurs="0" maxOccurs="1">
  12734. <annotation>
  12735. <documentation>
  12736. </documentation>
  12737. </annotation>
  12738. </element>
  12739. </sequence>
  12740. </complexType>
  12741. <simpleType name="BillingPeriodType">
  12742. <annotation>
  12743. <documentation>
  12744. </documentation>
  12745. </annotation>
  12746. <restriction base="xs:token">
  12747. <enumeration value="NoBillingPeriodType"/>
  12748. <enumeration value="Day"/>
  12749. <enumeration value="Week"/>
  12750. <enumeration value="SemiMonth"/>
  12751. <enumeration value="Month"/>
  12752. <enumeration value="Year"/>
  12753. </restriction>
  12754. </simpleType>
  12755. <complexType name="BillingPeriodDetailsType">
  12756. <sequence>
  12757. <element name="BillingPeriod" type="ns:BillingPeriodType" minOccurs="1" maxOccurs="1">
  12758. <annotation>
  12759. <documentation>
  12760. Unit of meausre for billing cycle
  12761. </documentation>
  12762. </annotation>
  12763. </element>
  12764. <element name="BillingFrequency" type="xs:int" minOccurs="1" maxOccurs="1">
  12765. <annotation>
  12766. <documentation>
  12767. Number of BillingPeriod that make up one billing cycle
  12768. </documentation>
  12769. </annotation>
  12770. </element>
  12771. <element name="TotalBillingCycles" type="xs:int" minOccurs="0" maxOccurs="1">
  12772. <annotation>
  12773. <documentation>
  12774. Total billing cycles in this portion of the schedule
  12775. </documentation>
  12776. </annotation>
  12777. </element>
  12778. <element name="Amount" type="cc:BasicAmountType" minOccurs="1" maxOccurs="1">
  12779. <annotation>
  12780. <documentation>
  12781. Amount to charge
  12782. </documentation>
  12783. </annotation>
  12784. </element>
  12785. <element name="ShippingAmount" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  12786. <annotation>
  12787. <documentation>
  12788. Additional shipping amount to charge
  12789. </documentation>
  12790. </annotation>
  12791. </element>
  12792. <element name="TaxAmount" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  12793. <annotation>
  12794. <documentation>
  12795. Additional tax amount to charge
  12796. </documentation>
  12797. </annotation>
  12798. </element>
  12799. </sequence>
  12800. </complexType>
  12801. <complexType name="BillingPeriodDetailsType_Update">
  12802. <sequence>
  12803. <element name="BillingPeriod" type="ns:BillingPeriodType" minOccurs="0" maxOccurs="1">
  12804. <annotation>
  12805. <documentation>
  12806. Unit of meausre for billing cycle
  12807. </documentation>
  12808. </annotation>
  12809. </element>
  12810. <element name="BillingFrequency" type="xs:int" minOccurs="0" maxOccurs="1">
  12811. <annotation>
  12812. <documentation>
  12813. Number of BillingPeriod that make up one billing cycle
  12814. </documentation>
  12815. </annotation>
  12816. </element>
  12817. <element name="TotalBillingCycles" type="xs:int" minOccurs="0" maxOccurs="1">
  12818. <annotation>
  12819. <documentation>
  12820. Total billing cycles in this portion of the schedule
  12821. </documentation>
  12822. </annotation>
  12823. </element>
  12824. <element name="Amount" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  12825. <annotation>
  12826. <documentation>
  12827. Amount to charge
  12828. </documentation>
  12829. </annotation>
  12830. </element>
  12831. <element name="ShippingAmount" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  12832. <annotation>
  12833. <documentation>
  12834. Additional shipping amount to charge
  12835. </documentation>
  12836. </annotation>
  12837. </element>
  12838. <element name="TaxAmount" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  12839. <annotation>
  12840. <documentation>
  12841. Additional tax amount to charge
  12842. </documentation>
  12843. </annotation>
  12844. </element>
  12845. </sequence>
  12846. </complexType>
  12847. <complexType name="ScheduleDetailsType">
  12848. <sequence>
  12849. <element name="Description" type="xs:string" minOccurs="1" maxOccurs="1">
  12850. <annotation>
  12851. <documentation>
  12852. Schedule details for the Recurring Payment
  12853. </documentation>
  12854. </annotation>
  12855. </element>
  12856. <element name="TrialPeriod" type="ns:BillingPeriodDetailsType" minOccurs="0" maxOccurs="1">
  12857. <annotation>
  12858. <documentation>
  12859. Trial period of this schedule
  12860. </documentation>
  12861. </annotation>
  12862. </element>
  12863. <element name="PaymentPeriod" type="ns:BillingPeriodDetailsType" minOccurs="1" maxOccurs="1">
  12864. <annotation>
  12865. <documentation>
  12866. </documentation>
  12867. </annotation>
  12868. </element>
  12869. <element name="MaxFailedPayments" type="xs:int" minOccurs="0" maxOccurs="1">
  12870. <annotation>
  12871. <documentation>
  12872. The max number of payments the buyer can fail before this Recurring Payments profile is cancelled
  12873. </documentation>
  12874. </annotation>
  12875. </element>
  12876. <element name="ActivationDetails" type="ns:ActivationDetailsType" minOccurs="0" maxOccurs="1">
  12877. <annotation>
  12878. <documentation>
  12879. </documentation>
  12880. </annotation>
  12881. </element>
  12882. <element name="AutoBillOutstandingAmount" type="ns:AutoBillType" minOccurs="0" maxOccurs="1">
  12883. <annotation>
  12884. <documentation>
  12885. </documentation>
  12886. </annotation>
  12887. </element>
  12888. </sequence>
  12889. </complexType>
  12890. <complexType name="RecurringPaymentsProfileDetailsType">
  12891. <sequence>
  12892. <element name="SubscriberName" type="xs:string" minOccurs="0" maxOccurs="1">
  12893. <annotation>
  12894. <documentation>
  12895. Subscriber name - if missing, will use name in buyer's account
  12896. </documentation>
  12897. </annotation>
  12898. </element>
  12899. <element name="SubscriberShippingAddress" type="ns:AddressType" minOccurs="0" maxOccurs="1">
  12900. <annotation>
  12901. <documentation>
  12902. Subscriber address - if missing, will use address in buyer's account
  12903. </documentation>
  12904. </annotation>
  12905. </element>
  12906. <element name="BillingStartDate" type="xs:dateTime" minOccurs="1" maxOccurs="1">
  12907. <annotation>
  12908. <documentation>
  12909. When does this Profile begin billing?
  12910. </documentation>
  12911. </annotation>
  12912. </element>
  12913. <element name="ProfileReference" type="xs:string" minOccurs="0" maxOccurs="1">
  12914. <annotation>
  12915. <documentation>Your own unique invoice or tracking number.
  12916. <br/>
  12917. <br/>
  12918. Optional
  12919. <br/>
  12920. <br/>Character length and limitations: 127 single-byte alphanumeric characters
  12921. </documentation>
  12922. </annotation>
  12923. </element>
  12924. </sequence>
  12925. </complexType>
  12926. <complexType name="CreateRecurringPaymentsProfileRequestDetailsType">
  12927. <sequence>
  12928. <element name="Token" type="xs:string" minOccurs="0" maxOccurs="1">
  12929. <annotation>
  12930. <documentation>
  12931. Billing Agreement token (required if Express Checkout)
  12932. </documentation>
  12933. </annotation>
  12934. </element>
  12935. <element name="CreditCard" type="ns:CreditCardDetailsType" minOccurs="0" maxOccurs="1">
  12936. <annotation>
  12937. <documentation>
  12938. Information about the credit card to be charged (required if Direct Payment)
  12939. </documentation>
  12940. </annotation>
  12941. </element>
  12942. <element name="RecurringPaymentsProfileDetails" type="ns:RecurringPaymentsProfileDetailsType" minOccurs="1" maxOccurs="1">
  12943. <annotation>
  12944. <documentation>
  12945. Customer Information for this Recurring Payments
  12946. </documentation>
  12947. </annotation>
  12948. </element>
  12949. <element name="ScheduleDetails" type="ns:ScheduleDetailsType" minOccurs="1" maxOccurs="1">
  12950. <annotation>
  12951. <documentation>
  12952. Schedule Information for this Recurring Payments
  12953. </documentation>
  12954. </annotation>
  12955. </element>
  12956. <element name="PaymentDetailsItem" type="ns:PaymentDetailsItemType" minOccurs="0" maxOccurs="unbounded">
  12957. <annotation>
  12958. <documentation>
  12959. Information about the Item Details.
  12960. </documentation>
  12961. </annotation>
  12962. </element>
  12963. </sequence>
  12964. </complexType>
  12965. <complexType name="CreateRecurringPaymentsProfileResponseDetailsType">
  12966. <sequence>
  12967. <element name="ProfileID" type="xs:string" minOccurs="1" maxOccurs="1">
  12968. <annotation>
  12969. <documentation>
  12970. Recurring Billing Profile ID
  12971. </documentation>
  12972. </annotation>
  12973. </element>
  12974. <element name="ProfileStatus" type="ns:RecurringPaymentsProfileStatusType" minOccurs="0" maxOccurs="1">
  12975. <annotation>
  12976. <documentation>
  12977. Recurring Billing Profile Status
  12978. </documentation>
  12979. </annotation>
  12980. </element>
  12981. <element name="TransactionID" type="xs:string" minOccurs="0" maxOccurs="1">
  12982. <annotation>
  12983. <documentation>
  12984. Transaction id from DCC initial payment
  12985. </documentation>
  12986. </annotation>
  12987. </element>
  12988. <element name="DCCProcessorResponse" type="xs:string" minOccurs="0" maxOccurs="1">
  12989. <annotation>
  12990. <documentation>
  12991. Response from DCC initial payment
  12992. </documentation>
  12993. </annotation>
  12994. </element>
  12995. <element name="DCCReturnCode" type="xs:string" minOccurs="0" maxOccurs="1">
  12996. <annotation>
  12997. <documentation>
  12998. Return code if DCC initial payment fails
  12999. </documentation>
  13000. </annotation>
  13001. </element>
  13002. </sequence>
  13003. </complexType>
  13004. <complexType name="GetRecurringPaymentsProfileDetailsResponseDetailsType">
  13005. <sequence>
  13006. <element name="ProfileID" type="xs:string" minOccurs="1" maxOccurs="1">
  13007. <annotation>
  13008. <documentation>
  13009. Recurring Billing Profile ID
  13010. </documentation>
  13011. </annotation>
  13012. </element>
  13013. <element name="ProfileStatus" type="ns:RecurringPaymentsProfileStatusType" minOccurs="1" maxOccurs="1">
  13014. <annotation>
  13015. <documentation>
  13016. </documentation>
  13017. </annotation>
  13018. </element>
  13019. <element name="Description" type="xs:string" minOccurs="1" maxOccurs="1">
  13020. <annotation>
  13021. <documentation>
  13022. </documentation>
  13023. </annotation>
  13024. </element>
  13025. <element name="AutoBillOutstandingAmount" type="ns:AutoBillType" minOccurs="1" maxOccurs="1">
  13026. <annotation>
  13027. <documentation>
  13028. </documentation>
  13029. </annotation>
  13030. </element>
  13031. <element name="MaxFailedPayments" type="xs:int" minOccurs="1" maxOccurs="1">
  13032. <annotation>
  13033. <documentation>
  13034. </documentation>
  13035. </annotation>
  13036. </element>
  13037. <element name="RecurringPaymentsProfileDetails" type="ns:RecurringPaymentsProfileDetailsType" minOccurs="1" maxOccurs="1">
  13038. <annotation>
  13039. <documentation>
  13040. </documentation>
  13041. </annotation>
  13042. </element>
  13043. <element name="CurrentRecurringPaymentsPeriod" type="ns:BillingPeriodDetailsType" minOccurs="0" maxOccurs="1">
  13044. <annotation>
  13045. <documentation>
  13046. </documentation>
  13047. </annotation>
  13048. </element>
  13049. <element name="RecurringPaymentsSummary" type="ns:RecurringPaymentsSummaryType" minOccurs="1" maxOccurs="1">
  13050. <annotation>
  13051. <documentation>
  13052. </documentation>
  13053. </annotation>
  13054. </element>
  13055. <element name="CreditCard" type="ns:CreditCardDetailsType" minOccurs="0" maxOccurs="1">
  13056. <annotation>
  13057. <documentation>
  13058. </documentation>
  13059. </annotation>
  13060. </element>
  13061. <element name="TrialRecurringPaymentsPeriod" type="ns:BillingPeriodDetailsType" minOccurs="0" maxOccurs="1">
  13062. <annotation>
  13063. <documentation>
  13064. </documentation>
  13065. </annotation>
  13066. </element>
  13067. <element name="RegularRecurringPaymentsPeriod" type="ns:BillingPeriodDetailsType" minOccurs="0" maxOccurs="1">
  13068. <annotation>
  13069. <documentation>
  13070. </documentation>
  13071. </annotation>
  13072. </element>
  13073. <element name="TrialAmountPaid" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  13074. <annotation>
  13075. <documentation>
  13076. </documentation>
  13077. </annotation>
  13078. </element>
  13079. <element name="RegularAmountPaid" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  13080. <annotation>
  13081. <documentation>
  13082. </documentation>
  13083. </annotation>
  13084. </element>
  13085. <element name="AggregateAmount" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  13086. <annotation>
  13087. <documentation>
  13088. </documentation>
  13089. </annotation>
  13090. </element>
  13091. <element name="AggregateOptionalAmount" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  13092. <annotation>
  13093. <documentation>
  13094. </documentation>
  13095. </annotation>
  13096. </element>
  13097. <element name="FinalPaymentDueDate" type="xs:dateTime" minOccurs="0" maxOccurs="1">
  13098. <annotation>
  13099. <documentation>
  13100. </documentation>
  13101. </annotation>
  13102. </element>
  13103. </sequence>
  13104. </complexType>
  13105. <complexType name="ManageRecurringPaymentsProfileStatusRequestDetailsType">
  13106. <sequence>
  13107. <element name="ProfileID" type="xs:string" minOccurs="1" maxOccurs="1">
  13108. <annotation>
  13109. <documentation>
  13110. </documentation>
  13111. </annotation>
  13112. </element>
  13113. <element name="Action" type="ns:StatusChangeActionType" minOccurs="1" maxOccurs="1">
  13114. <annotation>
  13115. <documentation>
  13116. </documentation>
  13117. </annotation>
  13118. </element>
  13119. <element name="Note" type="xs:string" minOccurs="0" maxOccurs="1">
  13120. <annotation>
  13121. <documentation>
  13122. </documentation>
  13123. </annotation>
  13124. </element>
  13125. </sequence>
  13126. </complexType>
  13127. <complexType name="ManageRecurringPaymentsProfileStatusResponseDetailsType">
  13128. <sequence>
  13129. <element name="ProfileID" type="xs:string" minOccurs="1" maxOccurs="1">
  13130. <annotation>
  13131. <documentation>
  13132. </documentation>
  13133. </annotation>
  13134. </element>
  13135. </sequence>
  13136. </complexType>
  13137. <complexType name="BillOutstandingAmountRequestDetailsType">
  13138. <sequence>
  13139. <element name="ProfileID" type="xs:string" minOccurs="1" maxOccurs="1">
  13140. <annotation>
  13141. <documentation>
  13142. </documentation>
  13143. </annotation>
  13144. </element>
  13145. <element name="Amount" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  13146. <annotation>
  13147. <documentation>
  13148. </documentation>
  13149. </annotation>
  13150. </element>
  13151. <element name="Note" type="xs:string" minOccurs="0" maxOccurs="1">
  13152. <annotation>
  13153. <documentation>
  13154. </documentation>
  13155. </annotation>
  13156. </element>
  13157. </sequence>
  13158. </complexType>
  13159. <complexType name="BillOutstandingAmountResponseDetailsType">
  13160. <sequence>
  13161. <element name="ProfileID" type="xs:string" minOccurs="1" maxOccurs="1">
  13162. <annotation>
  13163. <documentation>
  13164. </documentation>
  13165. </annotation>
  13166. </element>
  13167. </sequence>
  13168. </complexType>
  13169. <complexType name="UpdateRecurringPaymentsProfileRequestDetailsType">
  13170. <sequence>
  13171. <element name="ProfileID" type="xs:string" minOccurs="1" maxOccurs="1">
  13172. <annotation>
  13173. <documentation>
  13174. </documentation>
  13175. </annotation>
  13176. </element>
  13177. <element name="Note" type="xs:string" minOccurs="0" maxOccurs="1">
  13178. <annotation>
  13179. <documentation>
  13180. </documentation>
  13181. </annotation>
  13182. </element>
  13183. <element name="Description" type="xs:string" minOccurs="0" maxOccurs="1">
  13184. <annotation>
  13185. <documentation>
  13186. </documentation>
  13187. </annotation>
  13188. </element>
  13189. <element name="SubscriberName" type="xs:string" minOccurs="0" maxOccurs="1">
  13190. <annotation>
  13191. <documentation>
  13192. </documentation>
  13193. </annotation>
  13194. </element>
  13195. <element name="SubscriberShippingAddress" type="ns:AddressType" minOccurs="0" maxOccurs="1">
  13196. <annotation>
  13197. <documentation>
  13198. </documentation>
  13199. </annotation>
  13200. </element>
  13201. <element name="ProfileReference" type="xs:string" minOccurs="0" maxOccurs="1">
  13202. <annotation>
  13203. <documentation>
  13204. </documentation>
  13205. </annotation>
  13206. </element>
  13207. <element name="AdditionalBillingCycles" type="xs:int" minOccurs="0" maxOccurs="1">
  13208. <annotation>
  13209. <documentation>
  13210. </documentation>
  13211. </annotation>
  13212. </element>
  13213. <element name="Amount" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  13214. <annotation>
  13215. <documentation>
  13216. </documentation>
  13217. </annotation>
  13218. </element>
  13219. <element name="ShippingAmount" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  13220. <annotation>
  13221. <documentation>
  13222. </documentation>
  13223. </annotation>
  13224. </element>
  13225. <element name="TaxAmount" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  13226. <annotation>
  13227. <documentation>
  13228. </documentation>
  13229. </annotation>
  13230. </element>
  13231. <element name="OutstandingBalance" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  13232. <annotation>
  13233. <documentation>
  13234. </documentation>
  13235. </annotation>
  13236. </element>
  13237. <element name="AutoBillOutstandingAmount" type="ns:AutoBillType" minOccurs="0" maxOccurs="1">
  13238. <annotation>
  13239. <documentation>
  13240. </documentation>
  13241. </annotation>
  13242. </element>
  13243. <element name="MaxFailedPayments" type="xs:int" minOccurs="0" maxOccurs="1">
  13244. <annotation>
  13245. <documentation>
  13246. </documentation>
  13247. </annotation>
  13248. </element>
  13249. <element name="CreditCard" type="ns:CreditCardDetailsType" minOccurs="0" maxOccurs="1">
  13250. <annotation>
  13251. <documentation>
  13252. Information about the credit card to be charged (required if Direct Payment)
  13253. </documentation>
  13254. </annotation>
  13255. </element>
  13256. <element name="BillingStartDate" type="xs:dateTime" minOccurs="0" maxOccurs="1">
  13257. <annotation>
  13258. <documentation>
  13259. When does this Profile begin billing?
  13260. </documentation>
  13261. </annotation>
  13262. </element>
  13263. <element name="TrialPeriod" type="ns:BillingPeriodDetailsType_Update" minOccurs="0" maxOccurs="1">
  13264. <annotation>
  13265. <documentation>
  13266. Trial period of this schedule
  13267. </documentation>
  13268. </annotation>
  13269. </element>
  13270. <element name="PaymentPeriod" type="ns:BillingPeriodDetailsType_Update" minOccurs="0" maxOccurs="1">
  13271. <annotation>
  13272. <documentation>
  13273. </documentation>
  13274. </annotation>
  13275. </element>
  13276. </sequence>
  13277. </complexType>
  13278. <complexType name="UpdateRecurringPaymentsProfileResponseDetailsType">
  13279. <sequence>
  13280. <element name="ProfileID" type="xs:string" minOccurs="1" maxOccurs="1">
  13281. <annotation>
  13282. <documentation>
  13283. </documentation>
  13284. </annotation>
  13285. </element>
  13286. </sequence>
  13287. </complexType>
  13288. <complexType name="RiskFilterDetailsType">
  13289. <annotation>
  13290. <documentation>
  13291. Details of Risk Filter.
  13292. </documentation>
  13293. </annotation>
  13294. <sequence>
  13295. <element name="Id" type="xs:int" minOccurs="1" maxOccurs="1"> </element>
  13296. <element name="Name" type="xs:string" minOccurs="1" maxOccurs="1"> </element>
  13297. <element name="Description" type="xs:string" minOccurs="1" maxOccurs="1"> </element>
  13298. </sequence>
  13299. </complexType>
  13300. <complexType name="RiskFilterListType">
  13301. <annotation>
  13302. <documentation>
  13303. Details of Risk Filter.
  13304. </documentation>
  13305. </annotation>
  13306. <sequence>
  13307. <element name="Filters" type="ns:RiskFilterDetailsType" minOccurs="1" maxOccurs="unbounded"> </element>
  13308. </sequence>
  13309. </complexType>
  13310. <complexType name="FMFDetailsType">
  13311. <annotation>
  13312. <documentation>Thes are filters that could result in accept/deny/pending action.
  13313. </documentation>
  13314. </annotation>
  13315. <sequence>
  13316. <element name="AcceptFilters" type="ns:RiskFilterListType" minOccurs="0" maxOccurs="1"> </element>
  13317. <element name="PendingFilters" type="ns:RiskFilterListType" minOccurs="0" maxOccurs="1"> </element>
  13318. <element name="DenyFilters" type="ns:RiskFilterListType" minOccurs="0" maxOccurs="1"> </element>
  13319. <element name="ReportFilters" type="ns:RiskFilterListType" minOccurs="0" maxOccurs="1"> </element>
  13320. </sequence>
  13321. </complexType>
  13322. <simpleType name="ProductCategoryType">
  13323. <annotation>
  13324. <documentation>
  13325. </documentation>
  13326. </annotation>
  13327. <restriction base="xs:token">
  13328. <enumeration value="Other">
  13329. <annotation><documentation> Other</documentation> </annotation>
  13330. </enumeration>
  13331. <enumeration value="Airlines">
  13332. <annotation><documentation> Airlines</documentation> </annotation>
  13333. </enumeration>
  13334. <enumeration value="Antiques">
  13335. <annotation><documentation> Antiques</documentation> </annotation>
  13336. </enumeration>
  13337. <enumeration value="Art">
  13338. <annotation><documentation> Art</documentation> </annotation>
  13339. </enumeration>
  13340. <enumeration value="Cameras_Photos">
  13341. <annotation><documentation> Cameras &amp; Photos</documentation> </annotation>
  13342. </enumeration>
  13343. <enumeration value="Cars_Boats_Vehicles_Parts">
  13344. <annotation><documentation> Cars, Boats, Vehicles &amp; Parts</documentation> </annotation>
  13345. </enumeration>
  13346. <enumeration value="CellPhones_Telecom">
  13347. <annotation><documentation> Cell Phones &amp; Telecom</documentation> </annotation>
  13348. </enumeration>
  13349. <enumeration value="Coins_PaperMoney">
  13350. <annotation><documentation> Coins &amp; Paper Money</documentation> </annotation>
  13351. </enumeration>
  13352. <enumeration value="Collectibles">
  13353. <annotation><documentation> Collectibles</documentation> </annotation>
  13354. </enumeration>
  13355. <enumeration value="Computers_Networking">
  13356. <annotation><documentation> Computers &amp; Networking</documentation> </annotation>
  13357. </enumeration>
  13358. <enumeration value="ConsumerElectronics">
  13359. <annotation><documentation> Consumer Electronics</documentation> </annotation>
  13360. </enumeration>
  13361. <enumeration value="Jewelry_Watches">
  13362. <annotation><documentation> Jewelry &amp; Watches</documentation> </annotation>
  13363. </enumeration>
  13364. <enumeration value="MusicalInstruments">
  13365. <annotation><documentation> Musical Instruments</documentation> </annotation>
  13366. </enumeration>
  13367. <enumeration value="RealEstate">
  13368. <annotation><documentation> Real Estate</documentation> </annotation>
  13369. </enumeration>
  13370. <enumeration value="SportsMemorabilia_Cards_FanShop">
  13371. <annotation><documentation> Sports Memorabilia, Cards &amp; Fan Shop</documentation> </annotation>
  13372. </enumeration>
  13373. <enumeration value="Stamps">
  13374. <annotation><documentation> Stamps</documentation> </annotation>
  13375. </enumeration>
  13376. <enumeration value="Tickets">
  13377. <annotation><documentation> Tickets</documentation> </annotation>
  13378. </enumeration>
  13379. <enumeration value="Travels">
  13380. <annotation><documentation> Travels</documentation> </annotation>
  13381. </enumeration>
  13382. <enumeration value="Gambling">
  13383. <annotation><documentation> Gambling</documentation> </annotation>
  13384. </enumeration>
  13385. <enumeration value="Alcohol">
  13386. <annotation><documentation> Alcohol</documentation> </annotation>
  13387. </enumeration>
  13388. <enumeration value="Tobacco">
  13389. <annotation><documentation> Tobacco</documentation> </annotation>
  13390. </enumeration>
  13391. <enumeration value="MoneyTransfer">
  13392. <annotation><documentation> Money Transfer</documentation> </annotation>
  13393. </enumeration>
  13394. <enumeration value="Software">
  13395. <annotation><documentation> Software</documentation> </annotation>
  13396. </enumeration>
  13397. </restriction>
  13398. </simpleType>
  13399. <complexType name="EnhancedDataType">
  13400. <annotation>
  13401. <documentation>
  13402. Enhanced Data Information. Example: AID for Airlines
  13403. </documentation>
  13404. </annotation>
  13405. <sequence>
  13406. <element name="AirlineItinerary" type="ns:AirlineItineraryType" minOccurs="0" maxOccurs="1"/>
  13407. </sequence>
  13408. </complexType>
  13409. <complexType name="AirlineItineraryType">
  13410. <annotation>
  13411. <documentation>
  13412. AID for Airlines
  13413. </documentation>
  13414. </annotation>
  13415. <sequence>
  13416. <element name="PassengerName" type="xs:string" minOccurs="0"/>
  13417. <element name="IssueDate" type="xs:string" minOccurs="0"/>
  13418. <element name="TravelAgencyName" type="xs:string" minOccurs="0"/>
  13419. <element name="TravelAgencyCode" type="xs:string" minOccurs="0"/>
  13420. <element name="TicketNumber" type="xs:string" minOccurs="0"/>
  13421. <element name="IssuingCarrierCode" type="xs:string" minOccurs="0"/>
  13422. <element name="CustomerCode" type="xs:string" minOccurs="0"/>
  13423. <element name="TotalFare" type="cc:BasicAmountType" minOccurs="0"/>
  13424. <element name="TotalTaxes" type="cc:BasicAmountType" minOccurs="0"/>
  13425. <element name="TotalFee" type="cc:BasicAmountType" minOccurs="0"/>
  13426. <element name="RestrictedTicket" type="xs:string" minOccurs="0"/>
  13427. <element name="ClearingSequence" type="xs:string" minOccurs="0"/>
  13428. <element name="ClearingCount" type="xs:string" minOccurs="0"/>
  13429. <element name="FlightDetails" type="ns:FlightDetailsType" minOccurs="0" maxOccurs="unbounded"/>
  13430. </sequence>
  13431. </complexType>
  13432. <complexType name="FlightDetailsType">
  13433. <annotation>
  13434. <documentation>
  13435. Details of leg information
  13436. </documentation>
  13437. </annotation>
  13438. <sequence>
  13439. <element name="ConjuctionTicket" type="xs:string" minOccurs="0"/>
  13440. <element name="ExchangeTicket" type="xs:string" minOccurs="0"/>
  13441. <element name="CouponNumber" type="xs:string" minOccurs="0"/>
  13442. <element name="ServiceClass" type="xs:string" minOccurs="0"/>
  13443. <element name="TravelDate" type="xs:string" minOccurs="0"/>
  13444. <element name="CarrierCode" type="xs:string" minOccurs="0"/>
  13445. <element name="StopOverPermitted" type="xs:string" minOccurs="0"/>
  13446. <element name="DepartureAirport" type="xs:string" minOccurs="0"/>
  13447. <element name="ArrivalAirport" type="xs:string" minOccurs="0"/>
  13448. <element name="FlightNumber" type="xs:string" minOccurs="0"/>
  13449. <element name="DepartureTime" type="xs:string" minOccurs="0"/>
  13450. <element name="ArrivalTime" type="xs:string" minOccurs="0"/>
  13451. <element name="FareBasisCode" type="xs:string" minOccurs="0"/>
  13452. <element name="Fare" type="cc:BasicAmountType" minOccurs="0"/>
  13453. <element name="Taxes" type="cc:BasicAmountType" minOccurs="0"/>
  13454. <element name="Fee" type="cc:BasicAmountType" minOccurs="0"/>
  13455. <element name="EndorsementOrRestrictions" type="xs:string" minOccurs="0"/>
  13456. </sequence>
  13457. </complexType>
  13458. <complexType name="AuthorizationInfoType">
  13459. <annotation>
  13460. <documentation>
  13461. Authorization details
  13462. </documentation>
  13463. </annotation>
  13464. <sequence>
  13465. <element name="PaymentStatus" type="ns:PaymentStatusCodeType">
  13466. <annotation>
  13467. <documentation>
  13468. The status of the payment:
  13469. <br/>
  13470. <br/>
  13471. Pending: The payment is pending. See "PendingReason" for more information.
  13472. </documentation>
  13473. </annotation>
  13474. </element>
  13475. <element name="PendingReason" type="ns:PendingStatusCodeType" minOccurs="0">
  13476. <annotation>
  13477. <documentation>
  13478. The reason the payment is pending:
  13479. none: No pending reason
  13480. <br/>
  13481. <br/>
  13482. 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.
  13483. <br/>
  13484. <br/>
  13485. authorization: The authorization is pending at time of creation if payment is not under review
  13486. <br/>
  13487. <br/>
  13488. echeck: The payment is pending because it was made by an eCheck that has not yet cleared.
  13489. <br/>
  13490. <br/>
  13491. 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.
  13492. <br/>
  13493. <br/>
  13494. 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.
  13495. <br/>
  13496. <br/>
  13497. unilateral: The payment is pending because it was made to an email address that is not yet registered or confirmed.
  13498. <br/>
  13499. <br/>
  13500. 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.
  13501. <br/>
  13502. <br/>
  13503. verify: The payment is pending because you are not yet verified. You must verify your account before you can accept this payment.
  13504. <br/>
  13505. <br/>
  13506. payment_review: The payment is pending because it is under payment review.
  13507. <br/>
  13508. <br/>
  13509. other: The payment is pending for a reason other than those listed above. For more information, contact PayPal Customer Service.
  13510. </documentation>
  13511. </annotation>
  13512. </element>
  13513. <element name="ProtectionEligibility" type="xs:string" minOccurs="0">
  13514. <annotation>
  13515. <documentation>
  13516. Protection Eligibility for this Transaction - None, SPP or ESPP
  13517. </documentation>
  13518. </annotation>
  13519. </element>
  13520. <element name="ProtectionEligibilityType" type="xs:string" minOccurs="0">
  13521. <annotation>
  13522. <documentation>
  13523. Protection Eligibility Type for this Transaction
  13524. </documentation>
  13525. </annotation>
  13526. </element>
  13527. </sequence>
  13528. </complexType>
  13529. <simpleType name="ButtonCodeType">
  13530. <annotation>
  13531. <documentation>
  13532. Types of button coding
  13533. </documentation>
  13534. </annotation>
  13535. <restriction base="xs:token">
  13536. <enumeration value="HOSTED">
  13537. <annotation><documentation> Creates Hosted Button</documentation> </annotation>
  13538. </enumeration>
  13539. <enumeration value="ENCRYPTED">
  13540. <annotation><documentation> Creates Encrypted Button</documentation> </annotation>
  13541. </enumeration>
  13542. <enumeration value="CLEARTEXT">
  13543. <annotation><documentation> Creates Cleartext Button</documentation> </annotation>
  13544. </enumeration>
  13545. <enumeration value="TOKEN">
  13546. <annotation><documentation> Creates Token or temporary Button</documentation> </annotation>
  13547. </enumeration>
  13548. </restriction>
  13549. </simpleType>
  13550. <simpleType name="ButtonTypeType">
  13551. <annotation>
  13552. <documentation>
  13553. Types of buttons
  13554. </documentation>
  13555. </annotation>
  13556. <restriction base="xs:token">
  13557. <enumeration value="BUYNOW">
  13558. <annotation><documentation> button type is BUYNOW</documentation> </annotation>
  13559. </enumeration>
  13560. <enumeration value="CART">
  13561. <annotation><documentation> button type is CART</documentation> </annotation>
  13562. </enumeration>
  13563. <enumeration value="GIFTCERTIFICATE">
  13564. <annotation><documentation> button type is GIFTCERTIFICATE</documentation> </annotation>
  13565. </enumeration>
  13566. <enumeration value="SUBSCRIBE">
  13567. <annotation><documentation> button type is SUBSCRIBE</documentation> </annotation>
  13568. </enumeration>
  13569. <enumeration value="DONATE">
  13570. <annotation><documentation> button type is DONATE</documentation> </annotation>
  13571. </enumeration>
  13572. <enumeration value="UNSUBSCRIBE">
  13573. <annotation><documentation> button type is UNSUBSCRIBE</documentation> </annotation>
  13574. </enumeration>
  13575. <enumeration value="VIEWCART">
  13576. <annotation><documentation> button type is VIEWCART</documentation> </annotation>
  13577. </enumeration>
  13578. <enumeration value="PAYMENTPLAN">
  13579. <annotation><documentation> button type is PAYMENTPLAN</documentation> </annotation>
  13580. </enumeration>
  13581. <enumeration value="AUTOBILLING">
  13582. <annotation><documentation> button type is AUTOBILLING</documentation> </annotation>
  13583. </enumeration>
  13584. <enumeration value="PAYMENT">
  13585. <annotation><documentation> button type is PAYMENT</documentation> </annotation>
  13586. </enumeration>
  13587. </restriction>
  13588. </simpleType>
  13589. <simpleType name="ButtonSubTypeType">
  13590. <annotation>
  13591. <documentation>
  13592. Types of button sub types
  13593. </documentation>
  13594. </annotation>
  13595. <restriction base="xs:token">
  13596. <enumeration value="PRODUCTS">
  13597. <annotation><documentation> button subtype is PRODUCTS</documentation> </annotation>
  13598. </enumeration>
  13599. <enumeration value="SERVICES">
  13600. <annotation><documentation> button subtype is SERVICES</documentation> </annotation>
  13601. </enumeration>
  13602. </restriction>
  13603. </simpleType>
  13604. <simpleType name="ButtonImageType">
  13605. <annotation>
  13606. <documentation>
  13607. Types of button images
  13608. </documentation>
  13609. </annotation>
  13610. <restriction base="xs:token">
  13611. <enumeration value="REG">
  13612. <annotation><documentation> button image type is REG</documentation> </annotation>
  13613. </enumeration>
  13614. <enumeration value="SML">
  13615. <annotation><documentation> button image type is SML</documentation> </annotation>
  13616. </enumeration>
  13617. <enumeration value="CC">
  13618. <annotation><documentation> button image type is CC</documentation> </annotation>
  13619. </enumeration>
  13620. </restriction>
  13621. </simpleType>
  13622. <simpleType name="BuyNowTextType">
  13623. <annotation>
  13624. <documentation>
  13625. values for buynow button text
  13626. </documentation>
  13627. </annotation>
  13628. <restriction base="xs:token">
  13629. <enumeration value="BUYNOW">
  13630. <annotation><documentation> button wording is BUYNOW</documentation> </annotation>
  13631. </enumeration>
  13632. <enumeration value="PAYNOW">
  13633. <annotation><documentation> button wording is PAYNOW</documentation> </annotation>
  13634. </enumeration>
  13635. </restriction>
  13636. </simpleType>
  13637. <simpleType name="SubscribeTextType">
  13638. <annotation>
  13639. <documentation>
  13640. values for subscribe button text
  13641. </documentation>
  13642. </annotation>
  13643. <restriction base="xs:token">
  13644. <enumeration value="BUYNOW">
  13645. <annotation><documentation> button wording is BUYNOW</documentation> </annotation>
  13646. </enumeration>
  13647. <enumeration value="SUBSCRIBE">
  13648. <annotation><documentation> button wording is SUBSCRIBE</documentation> </annotation>
  13649. </enumeration>
  13650. </restriction>
  13651. </simpleType>
  13652. <simpleType name="ButtonStatusType">
  13653. <annotation>
  13654. <documentation>
  13655. values for subscribe button text
  13656. </documentation>
  13657. </annotation>
  13658. <restriction base="xs:token">
  13659. <enumeration value="DELETE">
  13660. <annotation><documentation> Changes Button Status to DELETE </documentation> </annotation>
  13661. </enumeration>
  13662. </restriction>
  13663. </simpleType>
  13664. <complexType name="OptionTrackingDetailsType">
  13665. <sequence>
  13666. <element name="OptionNumber" type="xs:string" minOccurs="0" maxOccurs="1">
  13667. <annotation>
  13668. <documentation>
  13669. Option Number.
  13670. <br/>
  13671. <b>Optional</b>
  13672. <br/>
  13673. </documentation>
  13674. </annotation>
  13675. </element>
  13676. <element name="OptionQty" type="xs:string" minOccurs="0" maxOccurs="1">
  13677. <annotation>
  13678. <documentation>
  13679. Option Quantity.
  13680. <br/>
  13681. <b>Optional</b>
  13682. <br/>
  13683. </documentation>
  13684. </annotation>
  13685. </element>
  13686. <element name="OptionSelect" type="xs:string" minOccurs="0" maxOccurs="1">
  13687. <annotation>
  13688. <documentation>
  13689. Option Select Name.
  13690. <br/>
  13691. <b>Optional</b>
  13692. <br/>
  13693. </documentation>
  13694. </annotation>
  13695. </element>
  13696. <element name="OptionQtyDelta" type="xs:string" minOccurs="0" maxOccurs="1">
  13697. <annotation>
  13698. <documentation>
  13699. Option Quantity Delta.
  13700. <br/>
  13701. <b>Optional</b>
  13702. <br/>
  13703. </documentation>
  13704. </annotation>
  13705. </element>
  13706. <element name="OptionAlert" type="xs:string" minOccurs="0" maxOccurs="1">
  13707. <annotation>
  13708. <documentation>
  13709. Option Alert.
  13710. <br/>
  13711. <b>Optional</b>
  13712. <br/>
  13713. </documentation>
  13714. </annotation>
  13715. </element>
  13716. <element name="OptionCost" type="xs:string" minOccurs="0" maxOccurs="1">
  13717. <annotation>
  13718. <documentation>
  13719. Option Cost.
  13720. <br/>
  13721. <b>Optional</b>
  13722. <br/>
  13723. </documentation>
  13724. </annotation>
  13725. </element>
  13726. </sequence>
  13727. </complexType>
  13728. <complexType name="ItemTrackingDetailsType">
  13729. <sequence>
  13730. <element name="ItemNumber" type="xs:string" minOccurs="0" maxOccurs="1">
  13731. <annotation>
  13732. <documentation>
  13733. Item Number.
  13734. <br/>
  13735. <b>Required</b>
  13736. <br/>
  13737. </documentation>
  13738. </annotation>
  13739. </element>
  13740. <element name="ItemQty" type="xs:string" minOccurs="0" maxOccurs="1">
  13741. <annotation>
  13742. <documentation>
  13743. Option Quantity.
  13744. <br/>
  13745. <b>Optional</b>
  13746. <br/>
  13747. </documentation>
  13748. </annotation>
  13749. </element>
  13750. <element name="ItemQtyDelta" type="xs:string" minOccurs="0" maxOccurs="1">
  13751. <annotation>
  13752. <documentation>
  13753. Item Quantity Delta.
  13754. <br/>
  13755. <b>Optional</b>
  13756. <br/>
  13757. </documentation>
  13758. </annotation>
  13759. </element>
  13760. <element name="ItemAlert" type="xs:string" minOccurs="0" maxOccurs="1">
  13761. <annotation>
  13762. <documentation>
  13763. Item Alert.
  13764. <br/>
  13765. <b>Optional</b>
  13766. <br/>
  13767. </documentation>
  13768. </annotation>
  13769. </element>
  13770. <element name="ItemCost" type="xs:string" minOccurs="0" maxOccurs="1">
  13771. <annotation>
  13772. <documentation>
  13773. Item Cost.
  13774. <br/>
  13775. <b>Optional</b>
  13776. <br/>
  13777. </documentation>
  13778. </annotation>
  13779. </element>
  13780. </sequence>
  13781. </complexType>
  13782. <complexType name="ButtonSearchResultType">
  13783. <sequence>
  13784. <element name="HostedButtonID" type="xs:string" minOccurs="0" maxOccurs="1"/>
  13785. <element name="ButtonType" type="xs:string" minOccurs="0" maxOccurs="1"/>
  13786. <element name="ItemName" type="xs:string" minOccurs="0" maxOccurs="1"/>
  13787. <element name="ModifyDate" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
  13788. </sequence>
  13789. </complexType>
  13790. <simpleType name="OptionTypeListType">
  13791. <annotation>
  13792. <documentation>
  13793. </documentation>
  13794. </annotation>
  13795. <restriction base="xs:token">
  13796. <enumeration value="NoOptionType"/>
  13797. <enumeration value="FULL"/>
  13798. <enumeration value="EMI"/>
  13799. <enumeration value="VARIABLE"/>
  13800. </restriction>
  13801. </simpleType>
  13802. <complexType name="ReverseTransactionRequestDetailsType">
  13803. <sequence>
  13804. <element name="TransactionID" type="ns:TransactionId" minOccurs="0" maxOccurs="1">
  13805. <annotation>
  13806. <documentation>Identifier of the transaction to reverse.
  13807. <br/>
  13808. <br/>
  13809. <b>Required</b>
  13810. <br/>
  13811. <br/>
  13812. Character length and limitations: 17 single-byte alphanumeric characters
  13813. </documentation>
  13814. </annotation>
  13815. </element>
  13816. </sequence>
  13817. </complexType>
  13818. <complexType name="ReverseTransactionResponseDetailsType">
  13819. <sequence>
  13820. <element name="ReverseTransactionID" type="ns:TransactionId" minOccurs="0" maxOccurs="1" nillable="true">
  13821. <annotation>
  13822. <documentation>Unique transaction identifier of the reversal transaction created.
  13823. <br/>
  13824. <br/>
  13825. Character length and limitations:17 single-byte characters
  13826. </documentation>
  13827. </annotation>
  13828. </element>
  13829. <element name="Status" type="xs:string" minOccurs="1" maxOccurs="1">
  13830. <annotation>
  13831. <documentation>Status of reversal request.
  13832. <br/>
  13833. <br/>
  13834. <b>Required</b>
  13835. <br/>
  13836. <br/>
  13837. </documentation>
  13838. </annotation>
  13839. </element>
  13840. </sequence>
  13841. </complexType>
  13842. <element name="ReverseTransactionRequestDetails" type="ns:ReverseTransactionRequestDetailsType"/>
  13843. <element name="ReverseTransactionResponseDetails" type="ns:ReverseTransactionResponseDetailsType"/>
  13844. <simpleType name="UserSelectedFundingSourceType">
  13845. <annotation>
  13846. <documentation>
  13847. UserSelectedFundingSourceType
  13848. User Selected Funding Source (used by Express Checkout)
  13849. </documentation>
  13850. </annotation>
  13851. <restriction base="xs:token">
  13852. <enumeration value="ELV"/>
  13853. <enumeration value="CreditCard"/>
  13854. <enumeration value="ChinaUnionPay"/>
  13855. <enumeration value="BML"/>
  13856. </restriction>
  13857. </simpleType>
  13858. <simpleType name="ItemCategoryType">
  13859. <annotation>
  13860. <documentation>
  13861. </documentation>
  13862. </annotation>
  13863. <restriction base="xs:token">
  13864. <enumeration value="Physical">
  13865. <annotation><documentation>Physical</documentation> </annotation>
  13866. </enumeration>
  13867. <enumeration value="Digital">
  13868. <annotation><documentation>Digital</documentation> </annotation>
  13869. </enumeration>
  13870. </restriction>
  13871. </simpleType>
  13872. <simpleType name="RecurringFlagType">
  13873. <annotation>
  13874. <documentation>
  13875. </documentation>
  13876. </annotation>
  13877. <restriction base="xs:token">
  13878. <enumeration value="Y"/>
  13879. <enumeration value="y"/>
  13880. </restriction>
  13881. </simpleType>
  13882. <complexType name="IncentiveInfoType">
  13883. <annotation>
  13884. <documentation>
  13885. Details of incentive application on individual bucket.
  13886. </documentation>
  13887. </annotation>
  13888. <sequence>
  13889. <element name="IncentiveCode" type="xs:string" minOccurs="0" maxOccurs="1">
  13890. <annotation>
  13891. <documentation>
  13892. Incentive redemption code.
  13893. </documentation>
  13894. </annotation>
  13895. </element>
  13896. <element name="ApplyIndication" type="ns:IncentiveApplyIndicationType" minOccurs="0" maxOccurs="unbounded">
  13897. <annotation>
  13898. <documentation>
  13899. Defines which bucket or item that the incentive should be applied to.
  13900. </documentation>
  13901. </annotation>
  13902. </element>
  13903. </sequence>
  13904. </complexType>
  13905. <complexType name="IncentiveApplyIndicationType">
  13906. <annotation>
  13907. <documentation>
  13908. Defines which bucket or item that the incentive should be applied to.
  13909. </documentation>
  13910. </annotation>
  13911. <sequence>
  13912. <element name="PaymentRequestID" type="xs:string" minOccurs="0" maxOccurs="1">
  13913. <annotation>
  13914. <documentation>
  13915. The Bucket ID that the incentive is applied to.
  13916. </documentation>
  13917. </annotation>
  13918. </element>
  13919. <element name="ItemId" type="xs:string" minOccurs="0" maxOccurs="1">
  13920. <annotation>
  13921. <documentation>
  13922. The item that the incentive is applied to.
  13923. </documentation>
  13924. </annotation>
  13925. </element>
  13926. </sequence>
  13927. </complexType>
  13928. <complexType name="PaymentRequestInfoType">
  13929. <sequence>
  13930. <annotation>
  13931. <documentation>
  13932. Contains payment request information for each bucket in the cart.
  13933. </documentation>
  13934. </annotation>
  13935. <element name="TransactionId" type="xs:string" minOccurs="0" maxOccurs="1">
  13936. <annotation>
  13937. <documentation>
  13938. Contains the transaction id of the bucket.
  13939. </documentation>
  13940. </annotation>
  13941. </element>
  13942. <element name="PaymentRequestID" type="xs:string" minOccurs="0" maxOccurs="1">
  13943. <annotation>
  13944. <documentation>
  13945. Contains the bucket id.
  13946. </documentation>
  13947. </annotation>
  13948. </element>
  13949. <element name="PaymentError" type="ns:ErrorType" minOccurs="0" maxOccurs="1">
  13950. <annotation>
  13951. <documentation>
  13952. Contains the error details.
  13953. </documentation>
  13954. </annotation>
  13955. </element>
  13956. </sequence>
  13957. </complexType>
  13958. <complexType name="ExternalRememberMeOwnerDetailsType">
  13959. <sequence>
  13960. <annotation>
  13961. <documentation>
  13962. E-mail address or secure merchant account ID of merchant to associate with new external remember-me.
  13963. </documentation>
  13964. </annotation>
  13965. <element name="ExternalRememberMeOwnerIDType" type="xs:string" minOccurs="0" maxOccurs="1">
  13966. <annotation>
  13967. <documentation>
  13968. A discriminant that tells SetEC what kind of data the ExternalRememberMeOwnerID parameter contains.
  13969. Currently, the owner must be either the API actor or omitted/none. In the future, we may allow the
  13970. owner to be a 3rd party merchant account.
  13971. Possible values are:
  13972. None, ignore the ExternalRememberMeOwnerID. An empty value for this field also signifies None.
  13973. Email, the owner ID is an email address
  13974. SecureMerchantAccountID, the owner id is a string representing the secure merchant account ID
  13975. </documentation>
  13976. </annotation>
  13977. </element>
  13978. <element name="ExternalRememberMeOwnerID" type="xs:string" minOccurs="0" maxOccurs="1">
  13979. <annotation>
  13980. <documentation>
  13981. When opting in to bypass login via remember me, this parameter specifies the merchant account
  13982. associated with the remembered login. Currentl, the owner must be either the API actor or omitted/none.
  13983. In the future, we may allow the owner to be a 3rd party merchant account.
  13984. If the Owner ID Type field is not present or "None", this parameter is ignored.
  13985. </documentation>
  13986. </annotation>
  13987. </element>
  13988. </sequence>
  13989. </complexType>
  13990. <complexType name="ExternalRememberMeOptInDetailsType">
  13991. <sequence>
  13992. <annotation>
  13993. <documentation>
  13994. This element contains information that allows the merchant to request to
  13995. opt into external remember me on behalf of the buyer or to request login
  13996. bypass using external remember me.
  13997. </documentation>
  13998. </annotation>
  13999. <element name="ExternalRememberMeOptIn" type="xs:string" minOccurs="0" maxOccurs="1">
  14000. <annotation>
  14001. <documentation>
  14002. 1 = opt in to external remember me.
  14003. 0 or omitted = no opt-in
  14004. Other values are invalid
  14005. </documentation>
  14006. </annotation>
  14007. </element>
  14008. <element name="ExternalRememberMeOwnerDetails" type="ns:ExternalRememberMeOwnerDetailsType" minOccurs="0" maxOccurs="1">
  14009. <annotation>
  14010. <documentation>
  14011. E-mail address or secure merchant account ID of merchant to associate with new external remember-me. Currently,
  14012. the owner must be either the API actor or omitted/none. In the future, we may allow the owner to be a 3rd party
  14013. merchant account.
  14014. </documentation>
  14015. </annotation>
  14016. </element>
  14017. </sequence>
  14018. </complexType>
  14019. <complexType name="FlowControlDetailsType">
  14020. <sequence>
  14021. <annotation>
  14022. <documentation>
  14023. An optional set of values related to flow-specific details.
  14024. </documentation>
  14025. </annotation>
  14026. <element name="ErrorURL" type="xs:string" minOccurs="0" maxOccurs="1">
  14027. <annotation>
  14028. <documentation>
  14029. The URL to redirect to for an unpayable transaction. This field is currently used only
  14030. for the inline checkout flow.
  14031. </documentation>
  14032. </annotation>
  14033. </element>
  14034. <element name="InContextReturnURL" type="xs:string" minOccurs="0" maxOccurs="1">
  14035. <annotation>
  14036. <documentation>
  14037. The URL to redirect to after a user clicks the "Pay" or "Continue" button on the merchant's
  14038. site. This field is currently used only for the inline checkout flow.
  14039. </documentation>
  14040. </annotation>
  14041. </element>
  14042. </sequence>
  14043. </complexType>
  14044. <complexType name="ExternalRememberMeStatusDetailsType">
  14045. <sequence>
  14046. <annotation>
  14047. <documentation>
  14048. Response information resulting from opt-in operation or current login bypass status.
  14049. </documentation>
  14050. </annotation>
  14051. <element name="ExternalRememberMeStatus" type="xs:integer" minOccurs="1" maxOccurs="1">
  14052. <annotation>
  14053. <documentation>
  14054. Required field that reports status of opt-in or login bypass attempt.
  14055. 0 = Success - successful opt-in or ExternalRememberMeID specified in SetExpressCheckout
  14056. is valid.
  14057. 1 = Invalid ID - ExternalRememberMeID specified in SetExpressCheckout is invalid.
  14058. 2 = Internal Error - System error or outage during opt-in or login bypass. Can retry
  14059. opt-in or login bypass next time. Flow will force full authentication and allow buyer
  14060. to complete transaction.
  14061. -1 = None - the return value does not signify any valid remember me status.
  14062. </documentation>
  14063. </annotation>
  14064. </element>
  14065. <element name="ExternalRememberMeID" type="xs:string" minOccurs="0" maxOccurs="1">
  14066. <annotation>
  14067. <documentation>
  14068. Identifier returned on external-remember-me-opt-in to allow the merchant to request
  14069. bypass of PayPal login through external remember me on behalf of the buyer in future
  14070. transactions. The ExternalRememberMeID is a 17-character alphanumeric (encrypted)
  14071. string. This field has meaning only to the merchant.
  14072. </documentation>
  14073. </annotation>
  14074. </element>
  14075. </sequence>
  14076. </complexType>
  14077. <complexType name="DisplayControlDetailsType">
  14078. <sequence>
  14079. <annotation>
  14080. <documentation>
  14081. Contains elements that allows customization of display (user interface) elements.
  14082. </documentation>
  14083. </annotation>
  14084. <element name="InContextPaymentButtonImage" type="xs:string" minOccurs="0" maxOccurs="1">
  14085. <annotation>
  14086. <documentation>
  14087. Optional URL to pay button image for the inline checkout flow. Currently applicable
  14088. only to the inline checkout flow when the FlowControlDetails/InlineReturnURL is present.
  14089. </documentation>
  14090. </annotation>
  14091. </element>
  14092. </sequence>
  14093. </complexType>
  14094. <complexType name="ExternalPartnerTrackingDetailsType">
  14095. <sequence>
  14096. <annotation>
  14097. <documentation>
  14098. Contains elements that allow tracking for an external partner.
  14099. </documentation>
  14100. </annotation>
  14101. <element name="ExternalPartnerSegmentID" type="xs:string" minOccurs="0" maxOccurs="1">
  14102. <annotation>
  14103. <documentation>
  14104. 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.
  14105. From a tracking/analytical perspective, PayPal would not infer any meaning to any specific value.
  14106. We would just segment the traffic based on the value passed (Cart and None as an example) and track different
  14107. metrics like risk/conversion etc based on these segments.
  14108. The external partner would control the value of what gets passed and we take that value as is and generate data based on it. <br/>
  14109. Optional <br/>
  14110. </documentation>
  14111. </annotation>
  14112. </element>
  14113. </sequence>
  14114. </complexType>
  14115. <complexType name="MerchantStoreDetailsType">
  14116. <sequence>
  14117. <element name="StoreID" type="xs:string" minOccurs="1" maxOccurs="1">
  14118. <annotation>
  14119. <documentation>Store ID<br/><br/>Optional<br/><br/>
  14120. Character length and limits: 50 single-byte characters
  14121. </documentation>
  14122. </annotation>
  14123. </element>
  14124. <element name="TerminalID" type="xs:string" minOccurs="0" maxOccurs="1">
  14125. <annotation>
  14126. <documentation>Terminal ID<br/><br/>Optional<br/><br/>
  14127. Character length and limits: 50 single-byte characters
  14128. </documentation>
  14129. </annotation>
  14130. </element>
  14131. </sequence>
  14132. </complexType>
  14133. <complexType name="AdditionalFeeType">
  14134. <sequence>
  14135. <element name="Type" type="xs:string" minOccurs="0" maxOccurs="1"/>
  14136. <element name="Amount" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1"/>
  14137. </sequence>
  14138. </complexType>
  14139. <complexType name="DiscountType">
  14140. <annotation>
  14141. <documentation>
  14142. Describes discount information
  14143. </documentation>
  14144. </annotation>
  14145. <sequence>
  14146. <element name="Name" type="xs:string" minOccurs="0" maxOccurs="1">
  14147. <annotation>
  14148. <documentation>Item name<br/><br/>Optional<br/><br/>
  14149. Character length and limits: 127 single-byte characters
  14150. </documentation>
  14151. </annotation>
  14152. </element>
  14153. <element name="Description" type="xs:string" minOccurs="0" maxOccurs="1">
  14154. <annotation>
  14155. <documentation>description of the discount<br/><br/>Optional<br/><br/>
  14156. Character length and limits: 127 single-byte characters
  14157. </documentation>
  14158. </annotation>
  14159. </element>
  14160. <element name="Amount" type="cc:BasicAmountType"
  14161. minOccurs="1" maxOccurs="1">
  14162. <annotation>
  14163. <documentation>amount discounted<br/><br/>Optional<br/><br/>
  14164. </documentation>
  14165. </annotation>
  14166. </element>
  14167. <element name="RedeemedOfferType" type="ns:RedeemedOfferType" minOccurs="0" maxOccurs="1">
  14168. <annotation>
  14169. <documentation>offer type<br/><br/>Optional<br/><br/>
  14170. </documentation>
  14171. </annotation>
  14172. </element>
  14173. <element name="RedeemedOfferID" type="xs:string"
  14174. minOccurs="0" maxOccurs="1">
  14175. <annotation>
  14176. <documentation>offer ID<br/><br/>Optional<br/><br/>
  14177. Character length and limits: 64 single-byte characters
  14178. </documentation>
  14179. </annotation>
  14180. </element>
  14181. </sequence>
  14182. </complexType>
  14183. <complexType name="InvoiceItemType">
  14184. <annotation>
  14185. <documentation>
  14186. Describes an individual item for an invoice.
  14187. </documentation>
  14188. </annotation>
  14189. <sequence>
  14190. <element name="Name" type="xs:string" minOccurs="0" maxOccurs="1">
  14191. <annotation>
  14192. <documentation>a human readable item name<br/><br/>Optional<br/><br/>
  14193. Character length and limits: 127 single-byte characters
  14194. </documentation>
  14195. </annotation>
  14196. </element>
  14197. <element name="Description" type="xs:string" minOccurs="0" maxOccurs="1">
  14198. <annotation>
  14199. <documentation>a human readable item description<br/><br/>Optional<br/><br/>
  14200. Character length and limits: 127 single-byte characters
  14201. </documentation>
  14202. </annotation>
  14203. </element>
  14204. <element name="EAN" type="xs:string" minOccurs="0" maxOccurs="1">
  14205. <annotation>
  14206. <documentation>
  14207. The International Article Number or
  14208. Universal Product Code (UPC) for the item.
  14209. Empty string is allowed.
  14210. Character length and limits: 17 single-byte characters
  14211. </documentation>
  14212. </annotation>
  14213. </element>
  14214. <element name="SKU" type="xs:string" minOccurs="0" maxOccurs="1">
  14215. <annotation>
  14216. <documentation>
  14217. The Stock-Keeping Unit or other identification
  14218. code assigned to the item.
  14219. Character length and limits: 64 single-byte characters
  14220. </documentation>
  14221. </annotation>
  14222. </element>
  14223. <element name="ReturnPolicyIdentifier" type="xs:string" minOccurs="0" maxOccurs="1">
  14224. <annotation>
  14225. <documentation>
  14226. A retailer could apply different return policies on different items.
  14227. Each return policy would be identified using a label or identifier.
  14228. This return policy identifier should be set here.
  14229. This identifier will be displayed next to the item in the e-Receipt.
  14230. Character length and limits: 8 single-byte characters
  14231. </documentation>
  14232. </annotation>
  14233. </element>
  14234. <element name="Price" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  14235. <annotation>
  14236. <documentation>
  14237. total price of this item
  14238. </documentation>
  14239. </annotation>
  14240. </element>
  14241. <element name="ItemPrice" type="cc:BasicAmountType" minOccurs="0" maxOccurs="1">
  14242. <annotation>
  14243. <documentation>
  14244. price per item quantity
  14245. </documentation>
  14246. </annotation>
  14247. </element>
  14248. <element name="ItemCount" type="xs:double" minOccurs="0" maxOccurs="1">
  14249. <annotation>
  14250. <documentation>
  14251. quantity of the item (non-negative)
  14252. </documentation>
  14253. </annotation>
  14254. </element>
  14255. <element name="ItemCountUnit" type="ns:UnitOfMeasure" minOccurs="0" maxOccurs="1">
  14256. <annotation>
  14257. <documentation>
  14258. Unit of measure for the itemCount
  14259. </documentation>
  14260. </annotation>
  14261. </element>
  14262. <element name="Discount" type="ns:DiscountType" minOccurs="0" maxOccurs="unbounded">
  14263. <annotation>
  14264. <documentation>
  14265. discount applied to this item
  14266. </documentation>
  14267. </annotation>
  14268. </element>
  14269. <element name="Taxable" type="xs:boolean" minOccurs="0" maxOccurs="1">
  14270. <annotation>
  14271. <documentation>
  14272. identifies whether this item is taxable or not.
  14273. If not passed, this will be assumed to be true.
  14274. </documentation>
  14275. </annotation>
  14276. </element>
  14277. <element name="TaxRate" type="xs:double" minOccurs="0" maxOccurs="1">
  14278. <annotation>
  14279. <documentation>
  14280. The tax percentage applied to the item.
  14281. This is only used for displaying in the receipt, it is not used in pricing calculations.
  14282. Note: we have totalTax at invoice level. It's up to the caller to do the calculations for setting that other element.
  14283. </documentation>
  14284. </annotation>
  14285. </element>
  14286. <element name="AdditionalFees" type="ns:AdditionalFeeType" minOccurs="0" maxOccurs="unbounded">
  14287. <annotation>
  14288. <documentation>
  14289. Additional fees to this item
  14290. </documentation>
  14291. </annotation>
  14292. </element>
  14293. <element name="Reimbursable" type="xs:boolean" minOccurs="0" maxOccurs="1">
  14294. <annotation>
  14295. <documentation>
  14296. identifies whether this is reimbursable or not.
  14297. If not pass, this will be assumed to be true.
  14298. </documentation>
  14299. </annotation>
  14300. </element>
  14301. <element name="MPN" type="xs:string" minOccurs="0" maxOccurs="1">
  14302. <annotation>
  14303. <documentation>
  14304. Manufacturer part number.
  14305. </documentation>
  14306. </annotation>
  14307. </element>
  14308. <element name="ISBN" type="xs:string" minOccurs="0" maxOccurs="1">
  14309. <annotation>
  14310. <documentation>
  14311. International Standard Book Number.
  14312. Reference http://en.wikipedia.org/wiki/ISBN
  14313. Character length and limits: 32 single-byte characters
  14314. </documentation>
  14315. </annotation>
  14316. </element>
  14317. <element name="PLU" type="xs:string" minOccurs="0" maxOccurs="1">
  14318. <annotation>
  14319. <documentation>
  14320. Price Look-Up code
  14321. Reference http://en.wikipedia.org/wiki/Price_Look-Up_code
  14322. Character length and limits: 5 single-byte characters
  14323. </documentation>
  14324. </annotation>
  14325. </element>
  14326. <element name="ModelNumber" type="xs:string" minOccurs="0" maxOccurs="1">
  14327. <annotation>
  14328. <documentation>
  14329. Character length and limits: 32 single-byte characters
  14330. </documentation>
  14331. </annotation>
  14332. </element>
  14333. <element name="StyleNumber" type="xs:string" minOccurs="0" maxOccurs="1">
  14334. <annotation>
  14335. <documentation>
  14336. Character length and limits: 32 single-byte characters
  14337. </documentation>
  14338. </annotation>
  14339. </element>
  14340. </sequence>
  14341. </complexType>
  14342. <complexType name="RefundInfoType">
  14343. <sequence>
  14344. <annotation>
  14345. <documentation>
  14346. Holds refunds payment status information
  14347. </documentation>
  14348. </annotation>
  14349. <element name="RefundStatus" type="ns:PaymentStatusCodeType" minOccurs="0" maxOccurs="1">
  14350. <annotation>
  14351. <documentation>
  14352. Refund status whether it is Instant or Delayed.
  14353. </documentation>
  14354. </annotation>
  14355. </element>
  14356. <element name="PendingReason" type="ns:PendingStatusCodeType" minOccurs="0" maxOccurs="1">
  14357. <annotation>
  14358. <documentation>
  14359. Tells us the reason when refund payment status is Delayed.
  14360. </documentation>
  14361. </annotation>
  14362. </element>
  14363. </sequence>
  14364. </complexType>
  14365. <element name="RefundInfo" type="ns:RefundInfoType"/>
  14366. </schema>