Developer's Guide

Adaptive Payments Developer Guide August 7, 2012 217
Refund API Operation
RefundRequest Message
ReceiverList Fields
Receiver Fields
receiverList ap:ReceiverList
(Optional) Information about the receivers of the payment that you want to
refund; the payment is identified by payment key, tracking ID, or transaction
ID. Specify each receiver to whom you want to issue a refund. You can specify
the refund amount for specific receivers. If you do not specify any receivers,
all receivers will be fully refunded if you specify the payment key or tracking
ID; otherwise, only the affected receiver will be fully refunded if you specify
the transaction ID.
requestEnvelope common:requestEnvelope
(Required) Information common to each API operation, such as the language
in which an error message is returned.
transactionId xs:string
(Optional) The PayPal transaction ID associated with the payment that you
want to refund.
trackingId xs:string
(Optional) The tracking ID associated with the payment that you want to
refund.
Field Description
receiver ap:Receiver
(Required) Receiver is the party whose account is credited.
Field Description
amount xs:decimal
(Required) Amount to be credited to the receiver’s account.
email xs:string
(Required) Receiver’s email address.
Maximum length: 127 characters
invoiceId xs:string
(Optional) This fields is not used.
Maximum length: 127 characters
paymentType xs:string
(Optional) This field is not used.
Field Description