What is the “Correlation ID” field in the API used for?

This field contains an alphanumeric string that allows PayPal to track every API call attempt. Every PayPal API response includes a Correlation ID field. If you contact PayPal with any questions regarding a specific API call, provide this value either in your support request or by attaching the log file to the ticket you create.

SOAP API response
Example of a Correlation ID returned in a SOAP API response:

<DoExpressCheckoutPaymentResponseType xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <Timestamp xmlns="urn:ebay:apis:eBLBaseComponents">2008-09-05T20:35:30Z</Timestamp>

  <Ack xmlns="urn:ebay:apis:eBLBaseComponents">Success</Ack>

  <CorrelationID xmlns="urn:ebay:apis:eBLBaseComponents">d02ac567bfe18</CorrelationID>

  <Version xmlns="urn:ebay:apis:eBLBaseComponents">53</Version>

  <Build xmlns="urn:ebay:apis:eBLBaseComponents">676720</Build>

NVP API response
Example of a Correlation ID returned in an NVP (Name-Value Pair) API response:

TIMESTAMP=2008-09-05T00:22:56Z&CORRELATIONID=23f585945be2f&ACK=Success&VERSION=53&BUILD=67133

What is the “Correlation ID” field in the API used for?

More ways we can help