Download PayPal SOAP API Developer - 2012 Reference Manual

13
RefundTransaction API Operation
RefundTransaction Request Message
NOT E :
Not all fields shown are available for use. Use only the fields described in the
documentation.
RefundTransaction Request Fields
Field
Description
TransactionID
xs:string
(Required) Unique identifier of the transaction to be refunded.
Character length and limitations: 17 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.
276
August 2012
SOAP API Developer Reference