On this page
No Headings
Last updated: May 20, 2026
Important: Adaptive Payments is not available for new integrations. PayPal provides this documentation to support existing integrations. If you're starting an integration, we recommend our latest solutions.
Shows the selected shipping address. You must have created the payment or preapproval key that identifies the account holder whose shipping address you want to obtain, or be the primary receiver of the payment or one of the parallel receivers of the payment. The shipping address is available only if it was provided during the embedded payment flow.
You must specify a value for the key field, which uses the payKey to identify the account holder.
| Field | Description |
|---|---|
key | xs:string(Required) The payment paykey that identifies the account holder for whom you want to obtain the selected shipping address. Note: Shipping information can only be retrieved through the payment payKey; not through the preapprovalKey. |
requestEnvelope | common:requestEnvelope(Required) Information common to each API operation, such as the language in which an error message is returned. |
| Field | Description |
|---|---|
detailLevel | common:DetailLevelCode(Optional) Level of detail required by the client application for components. Value is:
|
errorLanguage | xs:string(Required) RFC 3066 language in which error messages are returned; by default it is en_US, which is the only language currently supported. |
| Field | Description |
|---|---|
selectedAddress | ap:AddressAny number of available shipping addresses. The first address selected in the embedded payment flow. |
responseEnvelope | common:ResponseEnvelopeCommon response information, including a timestamp and the response acknowledgment status. |
| Field | Description |
|---|---|
addresseeName | xs:stringThe name associated with the address. |
baseAddress | common:BaseAddressStreet address. |
addressId | xs:stringThe ID associated with the address. |
| Field | Description |
|---|---|
city | xs:stringThe city of the address. |
countryCode | xs:stringThe country code of the address. |
line1 | xs:stringThe first line of the address. |
line2 | xs:stringAn second line of the street address. |
postalCode | xs:stringThe postal code of the address. |
state | xs:stringThe state for the address |
type | xs:string.The type of address. |
| Field | Description |
|---|---|
ack | common:AckCodeAcknowledgment code. Value is:
|
build | xs:stringBuild number. It is used only by PayPal Merchant Technical Support. |
correlationId | xs:stringCorrelation identifier. It is a 13-character, alphanumeric string (for example, db87c705a910e) that is used only by PayPal Merchant Technical Support.Note: You must log and store this data for every response you receive. PayPal Technical Support uses the information to assist with reported issues. |
timestamp | xs:datetimeDate on which the response was sent, for example: 2012-04-02T22:33:35.774-07:00Note: You must log and store this data for every response you receive. PayPal Technical Support uses the information to assist with reported issues. |
The PPFaultMessage returns ErrorData and the ResponseEnvelope information to your application if an error occurs.
| Field | Description |
|---|---|
error | common:ErrorDataDetailed error information. |
responseEnvelope | common:ResponseEnvelopeCommon response information, including a timestamp and the response acknowledgment status. |
| Field | Description |
|---|---|
category | common:ErrorCategoryThe location where the error occurred. Value is:
|
domain | xs:stringThe domain to which this service belongs. |
errorId | xs:longA 6-digit number that uniquely identifies a particular error. |
exceptionID | This field is not used. |
message | xs:stringA description of the error. |
parameter | common:ErrorParameterRepresents contextual information about the error. |
severity | common:ErrorSeverityThe severity of the error encountered. Value is:
|
subdomain | This field is not used. |
| Field | Description |
|---|---|
ack | common:AckCodeAcknowledgment code. Value is:
|
build | xs:stringBuild number. It is used only by PayPal Merchant Technical Support. |
correlationId | xs:stringCorrelation identifier. It is a 13-character, alphanumeric string (for example, db87c705a910e) that is used only by PayPal Merchant Technical Support. Note: You must log and store this data for every response you receive. PayPal Technical Support uses the information to assist with reported issues. |
timestamp | xs:datetimeDate on which the response was sent, for example: 2012-04-02T22:33:35.774-07:00 Note: You must log and store this data for every response you receive. PayPal Technical Support uses the information to assist with reported issues. |
| Code | Message | Additional Information |
|---|---|---|
| 520002 | Internal erro | |
| 520003 | Authentication failed. API credentials are incorrect. | Since 1.6.0 |
| 540031 | Operation is not permitted because the credentials do not match those of the initial operation | Since 1.6.0 |
| 550001 |
| Since 1.6.0 |
| 580001 | Invalid request: <value> | Since 1.6.0 |
| 580022 |
| Since 1.6.0 |
| 580029 | A pay key, transaction ID, or tracking ID is missing | Since 1.6.0 |
| 580030 | This transaction cannot be processed at this time. Please try again later. | Since 1.3.0 |