Developer's Guide

Refund API Operation
Refund API Overview
212 August 7, 2012 Adaptive Payments Developer Guide
Common fields for all refunds
You can refund a payment from all receivers associated with a payment by specifying the
payment’s payment key or tracking ID:
Refunds that apply to all receivers
You can make a refund to the sender of a payment from specific receivers associated with a
payment key or tracking ID. In this case, you must specify:
 either the payment key or tracking ID that identifies the original payment
 for each receiver making a refund, the receiver’s email address
 for each receiver, the amount to refund to the sender from the receiver’s account.
NOTE: The receiver can't make a partial refund if the original payment was a cash advance,
personal payment, or unilateral payment.
Additional fields for refunds of specific amounts to specific receivers
A payment can also be identified as a set of PayPal transactions between the sender and each
specific receiver. You can refund the amount of the transaction by specifying the transaction
ID:
Field Description
currencyCode The currency code. You must specify the currency code that
matches the currency code of the original payment unless
you also specify the payment key.
requestEnvelope.errorLanguage The code for the language in which errors are returned,
which must be en_US
Field Description
payKey The key used to create the payment that you want to refund
trackingId The tracking ID associated with the payment that you want
to refund
Field Description
receiverList.receiver(
n).email The receiver’s email address, where n is between 0 and 5 for
a maximum of 6 receivers
receiverList.receiver(
n).amount Amount to refund from the receiver identified by email
address