2013

SOAP API Developer Reference February 01, 2013 275
RefundTransaction API Operation
RefundTransaction Request Message
13
PayerID ebl:UserIDType
(Optional) Encrypted PayPal customer account identification number.
NOTE: Either the transaction ID or the payer ID must be specified.
Character length and limitations: 127 single-byte alphanumeric characters
InvoiceID xs:string
(Optional) Your own invoice or tracking number.
Character length and limitations: 127 single-byte alphanumeric characters
RefundType ebl:RefundPurposeTypeCodeType
Type of refund you are making. It is one of the following values:
 Full – Full refund (default).
 Partial – Partial refund.
 ExternalDispute – External dispute. (Value available since version 82.0)
 Other – Other type of refund. (Value available since version 82.0)
Amount ebl:BasicAmountType
(Optional) Refund amount. The amount is required if RefundType is Partial.
NOTE: If RefundType is Full, do not set the amount.
Character length and limitations: Value is a positive number which cannot exceed
$10,000 USD in any currency. It includes no currency symbol. It must have 2 decimal
places, the decimal separator must be a period (.), and the optional thousands
separator must be a comma (,).
Memo xs:string
(Optional) Custom memo about the refund.
Character length and limitations: 255 single-byte alphanumeric characters
RetryUntil xs:dateTime
(Optional) Maximum time until you must retry the refund.
NOTE: This field does not apply to point-of-sale transactions.
This field is available since version 82.0.
RefundSource ebl:RefundSourceCodeType
(Optional)Type of PayPal funding source (balance or eCheck) that can be used for
auto refund. It is one of the following values:
 any – The merchant does not have a preference. Use any available funding
source.
 default – Use the merchant’s preferred funding source, as configured in the
merchant’s profile.
 instant – Use the merchant’s balance as the funding source.
 eCheck – The merchant prefers using the eCheck funding source. If the
merchant’s PayPal balance can cover the refund amount, use the PayPal balance.
NOTE: This field does not apply to point-of-sale transactions.
This field is available since version 82.0.
Field Description