2013

Name-Value Pair API Developer Guide February 01, 2013 39
Authorization and Capture API Operation Reference
DoVoid API Operation
3
DoVoid API Operation
Void an order or an authorization.
DoVoid Request Message
DoVoid Request Fields
PROTECTIONELIGIBILITY
TYPE
Since version 64.4, the kind of seller protection in force for the transaction. It is
one of the following values:
 Eligible – Merchant is protected by PayPal's Seller Protection Policy for
both Unauthorized Payment and Item Not Received.
 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.
This field is available since version 64.4.
Field Description
METHOD (Required) Must be DoVoid.
AUTHORIZATIONID (Required) Original authorization ID specifying the authorization to void or, to void
an order, the order ID.
IMPORTANT: If you are voiding a transaction that has been reauthorized, use the ID
from the original authorization, and not the reauthorization.
Character length and limitations: 19 single-byte characters
NOTE (Optional) Informational note about this void that is displayed to the buyer in email
and in their transaction history.
Character length and limitations: 255 single-byte characters
MSGSUBID (Optional) 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. Exmples of this include requests due to timeouts or errors
during the original request.
Character length and limitations: 38 single-byte characters
This field is available since version 94.0.
Field Description