Reference Manual

PayPal Web Services API Architecture
SOAP Implementation
28 July 2006 Web Services API Reference
Response Structure
The following is an annotated description of the structure of a SOAP response from the PayPal
Web Services API.
EXAMPLE 2.1 General Structure of PayPal API SOAP Response: Success
1.<?xml version=”1.0”?>
2.<SOAP-ENV:Envelope
3. xmlns:SOAP-ENV=”http://schemas.xmlsoap.org/soap/envelope/”
4. xmlns:SOAP-ENC=”http://schemas.xmlsoap.org/soap/encoding/”
5. xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”
6. xmlns:xsd=”http://www.w3.org/2001/XMLSchema”
7. xmlns:xs=”http://www.w3.org/2001/XMLSchema”
8. xmlns:cc=”urn:ebay:apis:CoreComponentTypes”
9. xmlns:wsu=”http://schemas.xmlsoap.org/ws/2002/07/utility”
10. xmlns:saml=”urn:oasis:names:tc:SAML:1.0:assertion”
11. xmlns:ds=”http://www.w3.org/2000/09/xmldsig#”
12. xmlns:wsse=”http://schemas.xmlsoap.org/ws/2002/12/secext”
13. xmlns:ebl=”urn:ebay:apis:eBLBaseComponents”
14. xmlns:ns=”urn:ebay:api:PayPalAPI”>
15. <SOAP-ENV:Header>
16. <Security xmlns=”http://schemas.xmlsoap.org/ws/2002/12/secext”
xsi:type=”wsse:SecurityType”/>
17. <RequesterCredentials xmlns=”urn:ebay:api:PayPalAPI”
xsi:type=”ebl:CustomSecurityHeaderType”>
18. <Credentials xmlns=”urn:ebay:apis:eBLBaseComponents”
xsi:type=”ebl:UserIdPasswordType”/>
19. </RequesterCredentials>
20. </SOAP-ENV:Header>
21. <SOAP-ENV:Body id=”_0”>
22. <
specific_api_name_Response xmlns=”urn:ebay:api:PayPalAPI”>
23. <Timestamp>
dateTime_in_UTC/GMT</Timestamp>
24. <Ack xmlns=”urn:ebay:apis:eBLBaseComponents”>Success</Ack>
25. <Version xmlns=”urn:ebay:apis:eBLBaseComponents”>serviceVersion</Version>
26. <CorrelationId
xmlns=”urn:ebay:apis:eBLBaseComponents”>applicationCorrelation</CorrelationID>
27. <Build xmlns=”urn:ebay:apis:eBLBaseComponents”>
api_build_number</Build>
28. <
elements_for_specific_api_response>
29.
data
30. </elements_for_specific_api_response>
31. </
specific_api_name_Response>
32. </SOAP-ENV:Body>
33.</SOAP-ENV:Envelope>
22 The number of the PayPal Web Services API version is required on each SOAP request.
24 For details about required and optional elements and values for specific requests, see the
description of individual APIs.
TABLE 2.5 Annotation of Generic SOAP Request
Lines Comment