Integration Guide

PayPal Payments Pro Integration Guide April 2012 85
Getting Started With the PayPal Name-Value Pair API
Responding to an NVP Response
A
Responding to an NVP Response
The Name-Value Pair response consists of the answer to the request as well as common fields
that identify the API operation and how it was executed.
The following diagram shows fields in the response to a PayPal NVP API operation:
Common Response Fields
The PayPal API always returns common fields in addition to fields that are specific to the
requested PayPal API operation.
A PayPal API response includes the following fields:
Error Responses
If the ACK value is not Success, API response fields may not be returned. An error response
has the following general format.
Field Description
ACK Acknowledgement status, which is one of the following values:
 Success indicates a successful operation.
 SuccessWithWarning indicates a successful operation; however, there are
messages returned in the response that you should examine.
 Failure indicates the operation failed; the response also contains one or more error
messages explaining the failure.
 FailureWithWarning indicates that the operation failed and that there are
messages returned in the response that you should examine.
CORRELATIONID Correlation ID, which uniquely identifies the transaction to PayPal.
TIMESTAMP The date and time that the requested API operation was performed.
VERSION The version of the API.
BUILD The sub-version of the API.