Study Guide

PayPal Certified Developer Program Study Guide March 2008 91
Transactions
Authorization & Capture APIs
8
DoVoid Request
Use a DoVoid request to request a void for an authorization.
PAYMENTSTATUS The status of the payment:
z None — No status.
z Canceled-Reversal — A reversal was canceled. For example, the merchant
won a dispute with the customer, and the funds for the transaction that was
reversed were returned.
z Completed — The payment was completed, and the funds were added
successfully to the merchant’s account balance.
z Denied — The merchant denied the payment. This happens only if the
payment was previously pending because of possible reasons described in the
PENDINGREASON element.
z Expired — The authorization period for this payment was reached.
z Failed — The payment failed. This happens only if the payment was made
from the customer’s bank account.
z Pending — The payment is pending. For more information, see the
PENDINGREASON field.
z Refunded — The merchant refunded the payment.
z Reversed — A payment was reversed due to a chargeback or other type of
reversal. The funds were removed from the merchant’s account balance and
returned to the customer. The reason for the reversal is specified in the
REASONCODE element.
z Processed — A payment was accepted.
z Voided — An authorization for this transaction was voided.
T
ABLE 8.3 DoVoid Request Parameters
Parameter Description Required?
METHOD Name of API: DoVoid Yes
AUTHORIZATIONID The value of the original authorization identification number returned by
PayPal.
I MPORTANT: If the merchant is voiding a transaction that was
reauthorized, use the ID from the original authorization,
not the reauthorization.
Character length and limits: 19 single-byte characters
Yes
NOTE An informational note about this void that is displayed to the customer
in email and in the transaction history.
Character length and limits: 255 single-byte characters
No
T
ABLE 8.2 DoCapture Response Fields (Continued)
Field Description