Core eBL Request/Response Structures

The PayPal SOAP API is built on core structures from the eBL schema that define required elements in all SOAP requests and responses:

l	AbstractRequestType

l	AbstractResponseType

Diagram of core eBL Types

The following diagram represents the composition of the AbstractRequestType and AbstractResponseType elements.

Figure 2.1

Core eBL Types

AbstractRequestType

AbstractRequestType is the base type definition of all PayPal SOAP requests.

IMPORTANT:

You must set the value of the Version element for all requests to any PayPal API.

Table 2.1

AbstractRequestType Fields

Element	Description	Required?
Version	xs:string A string representing the version of the PayPal Schema., specifically, the value the version attribute of the wsdl:definitions element . For the location of the PayPal Schema, see “PayPal WSDL/XSD Schema Definitions”.	Yes

AbstractResponseType

AbstractResponseType is the base type definition of all PayPal SOAP responses.

For error codes and messages and their meanings, see Appendix A, “Error Codes and Messages for All PayPal APIs.”

Table 2.2

AbstractResponseType Fields

Element	Description
Timestamp	xs:dateTime The date and time (UTC/GMT) the response was generated by the PayPal SOAP service as a result of processing a request.
Ack	xs:token A token representing the application-level acknowledgement code. Contains one of the following enumerated values: l Success: Request processing succeeded l Failure: Request processing failed l SuccessWithWarning: Request processing completed successfully but with some warning information in Errors that could be useful for the requesting application to process or record. l FailureWithWarning: Request processing failed with some error and warning information that the requesting application should process to determine causes of failure. l CustomCode: Reserved for internal or future use.
CorrelationID	xs:string A string that identifies the exact API request that produced this response Character length: 41 characters maximum.
Errors	ns:ErrorType ns:SeverityCodeType Error code and messages for debugging a response. l ErrorCode: token defining the error code number l ShortMessage: string containing the error message l LongMessage: string describing the error message l ErrorParameters: error parameters from the credit card processor. Returned only with DoDirectPaymentResponse. l SeverityCode: returns Error or Warning.
Version	xs:string A string representing the version of the PayPal Schema, specifically, the value of the version attribute of the wsdl:definitions element . For the location of the PayPal Schema, see “PayPal WSDL/XSD Schema Definitions”.
Build	xs:string A string representing the specific software build that processes the request and generates the response