UpdateAuthorization API Operation (SOAP)

Important: NVP/SOAP is a legacy integration method. We accept new integrations and support existing integrations, but there are newer solutions. If you're starting an integration, we recommend our latest solutions.

Note: Advanced permission from PayPal is required to use this API operation.

Changes the shipping address of an existing authorization transaction. To use this API operation, the original authorization should still be open, not completed, not reversed, not voided, and not on hold for any reason.

UpdateAuthorization Request Message

UpdateAuthorization Request Fields

Field, Description
Field	Description
`TransactionID`	`xs:string` (Required) The value of the authorization's transaction identification number returned by a PayPal API. Character length and limitations: 17 characters. Orders transactions have 19 characters.
`ShipToAddress`	``ebl:AddressType (Optional) Shipping address for this order.
`IPAddress`	`xs:string` (Optional) IP address of the customer.

AddressType Fields

Field, Description
Field	Description
`Name`	`xs:string` Person's name associated with this shipping address. It is required if using a shipping address. Character length and limitations: 128 double-byte characters
`Street1`	`xs:string` First street address. It is required if using a shipping address. Character length and limitations: 100 single-byte characters
`Street2`	`xs:string` (Optional) Second street address. Character length and limitations: 100 single-byte characters
`CityName`	`xs:string` Name of city. It is required if using a shipping address. Character length and limitations: 40 single-byte characters
`StateOrProvince`	`xs:string` State or province. Required for transactions only if the address is in one of the following countries: Argentina, Brazil, Canada, China, Indonesia, India, Japan, Mexico, Thailand or USA. See the list of PayPal state codes. Character length and limitations: 40 single-byte characters
`PostalCode`	`xs:string` U.S. ZIP code or other country-specific postal code. It is required if using a U.S. shipping address; may be required for other countries. Character length and limitations: 20 single-byte characters
`Country`	`ebl:CountryCodeType` Country code. It is required if using a shipping address. Character length and limitations: 2 single-byte characters
`Phone`	`xs:string` (Optional) Phone number. Character length and limitations: 20 single-byte characters a name="req-shiptostore">/td>
`ShipToStore`	`xs:string` (Optional) Indicates if the item purchased will be shipped to a store location.

UpdateAuthorization Response Message

UpdateAuthorization Response Fields

Field, Description
Field	Description
`TransactionID`	`xs:string` (Optional) Authorization identification number of the original transaction passed in the request. Character length and limitations: 17 characters. Orders transactions have 19 characters.
`AuthorizationInfo`	`ns:AuthorizationInfoType` Details on the Authorization transaction such as the payment status, pending reason (if applicable), and protection eligibility.
`MsgSubID`	`xs:string` A message ID used for idempotence to uniquely identify a message. This ID can later be used to request the latest results for a previous request without generating a new request. Examples of this include requests due to timeouts or errors during the original request. Character length and limitations: string of up to 38 single-byte characters.

AuthorizationInfoType Fields

Field, Description
Field	Description
`PaymentStatus`	`ebl:PaymentStatusCodeType` Status of the payment. Value is: `None` — No status. `Canceled-Reversal` — A reversal has been canceled. For example, when you win a dispute, PayPal returns the funds for the reversal to you. `Completed` — The payment has been completed, and the funds have been added successfully to your account balance. `Denied` — You denied the payment. This happens only if the payment was previously pending because of possible reasons described for the `PendingReason` element. `Expired` — The authorization period for this payment has been reached. `Failed` — The payment has failed. This happens only if the payment was made from the buyer's bank account. `In-Progress` — The transaction has not terminated. For example, an authorization may be awaiting completion. `Partially-Refunded` — The payment has been partially refunded. `Pending` — The payment is pending. See the `PendingReason` field for more information. `Refunded` — You refunded the payment. `Reversed`— A payment was reversed due to a chargeback or other type of reversal. PayPal removes the funds from your account balance and returns them to the buyer. The `ReasonCode` element specifies the reason for the reversal. `Processed` — A payment has been accepted. `Voided` — An authorization for this transaction has been voided.
`PendingReason`	`ebl:PendingStatusCodeType` Reason the payment is pending. Value is: `none` — No pending reason. `address` — The payment is pending because your customer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments. To change your preference, go to the `Preferences` section of your `Profile`. `authorization` — The payment is pending because it has been authorized but not settled. You must capture the funds first. `echeck` — The payment is pending because it was made by an eCheck that has not yet cleared. `intl` — The payment is pending because you hold a non-U.S. account and do not have a withdrawal mechanism. You must manually accept or deny this payment from your `Account Overview`. `multi-currency` — You do not have a balance in the currency sent, and you do not have your `Payment Receiving Preferences` set to automatically convert and accept this payment. You must manually accept or deny this payment. `order` — The payment is pending because it is part of an order that has been authorized but not settled. `paymentreview` — The payment is pending while it is being reviewed by PayPal for risk. `regulatoryreview` - The payment is pending while we make sure it meets regulatory requirements. You will be contacted again in 24-72 hours with the outcome of the review. `unilateral` — The payment is pending because it was made to an email address that is not yet registered or confirmed. `verify` — The payment is pending because you are not yet verified. You must verify your account before you can accept this payment. `other` — The payment is pending for a reason other than those listed above. For more information, contact PayPal Customer Service. Note: `PendingReason` is returned in the response only if `PaymentStatus` is `Pending`.
`ProtectionEligibility`	`xs:string` Prior to version 64.4, the kind of seller protection in force for the transaction. Value is: `Eligible` — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payment and Item Not Received. `PartiallyEligible` — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received. `Ineligible` — Merchant is not protected under the Seller Protection Policy.
`ProtectionEligibilityType`	`xs:string` Since version 64.4, the type of seller protection in force for the transaction. It is one or more of the following values: `ItemNotReceivedEligible` – Merchant is protected by PayPal's Seller Protection Policy for Item Not Received. `UnauthorizedPaymentEligible` – Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payment. `Ineligible` – Merchant is not protected under the Seller Protection Policy. Note: If more than one of these values is returned in this field, they are returned in a comma-delimited string; for example, `ItemNotReceivedEligible,UnauthorizedPaymentEligible`. This field is available since version 64.4.

Additional information

API error codes

UpdateAuthorization Request Message

Field, Description
Field	Description
`TransactionID`	`xs:string` (Required) The value of the authorization's transaction identification number returned by a PayPal API. Character length and limitations: 17 characters. Orders transactions have 19 characters.
`ShipToAddress`	``ebl:AddressType (Optional) Shipping address for this order.
`IPAddress`	`xs:string` (Optional) IP address of the customer.

Field, Description
Field	Description
`Name`	`xs:string` Person's name associated with this shipping address. It is required if using a shipping address. Character length and limitations: 128 double-byte characters
`Street1`	`xs:string` First street address. It is required if using a shipping address. Character length and limitations: 100 single-byte characters
`Street2`	`xs:string` (Optional) Second street address. Character length and limitations: 100 single-byte characters
`CityName`	`xs:string` Name of city. It is required if using a shipping address. Character length and limitations: 40 single-byte characters
`StateOrProvince`	`xs:string` State or province. Required for transactions only if the address is in one of the following countries: Argentina, Brazil, Canada, China, Indonesia, India, Japan, Mexico, Thailand or USA. See the list of PayPal state codes. Character length and limitations: 40 single-byte characters
`PostalCode`	`xs:string` U.S. ZIP code or other country-specific postal code. It is required if using a U.S. shipping address; may be required for other countries. Character length and limitations: 20 single-byte characters
`Country`	`ebl:CountryCodeType` Country code. It is required if using a shipping address. Character length and limitations: 2 single-byte characters
`Phone`	`xs:string` (Optional) Phone number. Character length and limitations: 20 single-byte characters a name="req-shiptostore">/td>
`ShipToStore`	`xs:string` (Optional) Indicates if the item purchased will be shipped to a store location.

UpdateAuthorization Response Message

Field, Description
Field	Description
`TransactionID`	`xs:string` (Optional) Authorization identification number of the original transaction passed in the request. Character length and limitations: 17 characters. Orders transactions have 19 characters.
`AuthorizationInfo`	`ns:AuthorizationInfoType` Details on the Authorization transaction such as the payment status, pending reason (if applicable), and protection eligibility.
`MsgSubID`	`xs:string` A message ID used for idempotence to uniquely identify a message. This ID can later be used to request the latest results for a previous request without generating a new request. Examples of this include requests due to timeouts or errors during the original request. Character length and limitations: string of up to 38 single-byte characters.

Field, Description
Field	Description
`PaymentStatus`	`ebl:PaymentStatusCodeType` Status of the payment. Value is: `None` — No status. `Canceled-Reversal` — A reversal has been canceled. For example, when you win a dispute, PayPal returns the funds for the reversal to you. `Completed` — The payment has been completed, and the funds have been added successfully to your account balance. `Denied` — You denied the payment. This happens only if the payment was previously pending because of possible reasons described for the `PendingReason` element. `Expired` — The authorization period for this payment has been reached. `Failed` — The payment has failed. This happens only if the payment was made from the buyer's bank account. `In-Progress` — The transaction has not terminated. For example, an authorization may be awaiting completion. `Partially-Refunded` — The payment has been partially refunded. `Pending` — The payment is pending. See the `PendingReason` field for more information. `Refunded` — You refunded the payment. `Reversed`— A payment was reversed due to a chargeback or other type of reversal. PayPal removes the funds from your account balance and returns them to the buyer. The `ReasonCode` element specifies the reason for the reversal. `Processed` — A payment has been accepted. `Voided` — An authorization for this transaction has been voided.
`PendingReason`	`ebl:PendingStatusCodeType` Reason the payment is pending. Value is: `none` — No pending reason. `address` — The payment is pending because your customer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments. To change your preference, go to the `Preferences` section of your `Profile`. `authorization` — The payment is pending because it has been authorized but not settled. You must capture the funds first. `echeck` — The payment is pending because it was made by an eCheck that has not yet cleared. `intl` — The payment is pending because you hold a non-U.S. account and do not have a withdrawal mechanism. You must manually accept or deny this payment from your `Account Overview`. `multi-currency` — You do not have a balance in the currency sent, and you do not have your `Payment Receiving Preferences` set to automatically convert and accept this payment. You must manually accept or deny this payment. `order` — The payment is pending because it is part of an order that has been authorized but not settled. `paymentreview` — The payment is pending while it is being reviewed by PayPal for risk. `regulatoryreview` - The payment is pending while we make sure it meets regulatory requirements. You will be contacted again in 24-72 hours with the outcome of the review. `unilateral` — The payment is pending because it was made to an email address that is not yet registered or confirmed. `verify` — The payment is pending because you are not yet verified. You must verify your account before you can accept this payment. `other` — The payment is pending for a reason other than those listed above. For more information, contact PayPal Customer Service. Note: `PendingReason` is returned in the response only if `PaymentStatus` is `Pending`.
`ProtectionEligibility`	`xs:string` Prior to version 64.4, the kind of seller protection in force for the transaction. Value is: `Eligible` — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payment and Item Not Received. `PartiallyEligible` — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received. `Ineligible` — Merchant is not protected under the Seller Protection Policy.
`ProtectionEligibilityType`	`xs:string` Since version 64.4, the type of seller protection in force for the transaction. It is one or more of the following values: `ItemNotReceivedEligible` – Merchant is protected by PayPal's Seller Protection Policy for Item Not Received. `UnauthorizedPaymentEligible` – Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payment. `Ineligible` – Merchant is not protected under the Seller Protection Policy. Note: If more than one of these values is returned in this field, they are returned in a comma-delimited string; for example, `ItemNotReceivedEligible,UnauthorizedPaymentEligible`. This field is available since version 64.4.

UpdateAuthorization API Operation (SOAP)

UpdateAuthorization Request Message

UpdateAuthorization Request Fields

AddressType Fields

UpdateAuthorization Response Message

UpdateAuthorization Response Fields

AuthorizationInfoType Fields

Additional information

On this page

On this page

On this page

UpdateAuthorization API Operation (SOAP)

UpdateAuthorization Request Message

UpdateAuthorization Request Fields

AddressType Fields

UpdateAuthorization Response Message

UpdateAuthorization Response Fields

AuthorizationInfoType Fields

Additional information

On this page

On this page

UpdateAuthorization API Operation (SOAP)

On this page

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

UpdateAuthorization API Operation (SOAP)

On this page

On this page