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.
Cancels preapprovals. Preapprovals can be canceled regardless of the state they are in, such as active, expired, deactivated, and previously canceled.
The CancelPreapprovalRequest message specifies which preapproval is to be canceled by identifying the preapproval with its the preapproval key.
The table below lists the fields for the CancelPreapprovalRequest message.
| Field | Description |
|---|---|
preapprovalKey | xs:string(Required) The preapproval key that identifies the preapproval to be canceled. |
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. |
The CancelPreapprovalResponse message contains information returned in response to a CancelPreapprovalRequest message.
| Field | Description |
|---|---|
responseEnvelope | common:ResponseEnvelopeCommon response information, including a timestamp and the response acknowledgment status. |
| 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. |
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 error | |
| 540031 | You don't have permission to cancel this preapproval | |
| 589019 | The preapproval key is invalid |