AdaptiveRefund Class

Properties   Methods   Events   Configuration Settings   Errors  

The AdaptiveRefund component is used to make refunds of simple, chained, or parallel payments that were authorized via the ADAPTIVEPAY component.

Syntax

AdaptiveRefund

Remarks

In a refund, the terms sender and recipient refer to sender and receivers of the original payment made using the AdaptivePay class. When making a refund, the sender's account receives the refund and the receivers' accounts are the sources of the refund. Refunds are made from one or more receivers to a sender.

To make a refund using the AdaptiveRefund class, you must have made an AdaptivePay request for which payment you want to refund, or you must have received the part of the payment you want to refund, and you must have permission to make a refund on behalf of the receiver, unless you are also the receiver; in other words, each receiver from whose account is the source of the refund must have granted you third-party access permission to call the Refund API operation.

To refund a payment from all receivers associated with a payment, simply specify the PaymentKey or TrackingId and call IssueRefund. You can also make a refund to the sender of a payment from specific receivers associated with a PaymentKey or TrackingId. In this case, you must also specify the PaymentKey or TrackingId associated with the original payment, but in addition you need to supply the RecipientEmail and RecipientAmount for each of the Recipients you wish to make a refund from. Then call IssueRefund.

A payment can also be identified as a set of PayPal transactions between the sender and each specific receiver. You can refund only one of the transactions in this set by specifying the TransactionId instead.

After calling IssueRefund, the results of each refund processed will be stored in the Refunds collection.

Additional Notes About the Refund API Operation

• Note that payments made using the AdaptivePay class cannot be refunded using the RefundTransaction class. You must use the AdaptiveRefund class or log in to PayPal to issue the refund.
• A personal account holder cannot grant API access to a third party. A personal account holder must issue the refund by specifying the TransactionId, or by logging in to paypal.com to make the refund.
• A payment made using the AdaptivePay class cannot be refunded by logging in to paypal.com if the fees cannot be refunded. In these cases, you must use the AdaptiveRefund class operation to issue the refund.
• In the refund request, Specify the payment you're interested in using either the PaymentKey, TransactionId, or TrackingId. It is not recommended to specify more than one of these properties, unless they identify the same payment. If the properties do not belong to the same payment, the TransactionId is used; next, PayPal uses the PaymentKey. If more than one of these is specified, the TrackingId is never used.
• With the AdaptivePay class you can make payments to a person who does not have a PayPal account. In essence, you send a payment request that includes an email address for a receiver, and this email address is not linked to a registered PayPal account. The receiver receives an email notifying the receiver to create an account and claim the payment. Supporting features include email notifications and IPNs to the sender, receiver, and API caller, plus the ability to cancel unclaimed payments. You can make such a payment in the same way that you make any other kind of payment; however, PayPal holds a payment to a receiver whose email address is not yet registered or confirmed until the receiver creates a PayPal account and confirms the email address. If a refund specifies a receiver whose email address is not yet registered or confirmed, the payment to the receiver is canceled.
• For chained payments, if the primary recipient's account has insufficient funds to cover the refund, an eCheck is issued, and the refund is put on hold until the check clears. No money will be moved from the secondary receivers' accounts until the primary receiver's fund are available using eCheck. Note that the Refund API operation does not support iACH.