RefundInfo Type

Represents the refund attempt made to a receiver of an Adaptive Payment.

Remarks

This type contains information about a single refund that was processed using the AdaptiveRefund component.

Error
String

Information about why a refund failed.

FeeAmountRefunded
String

The amount of fees that have been refunded.

FullRefund
boolean

Indicates whether you have refunded the total amount of the payment.

If this field is True, it means the entire amount of the payment has been refunded.

GrossAmountRefunded
String

Gross amount of the refund, including the total amount from this recipient plus fees.

NetAmountRefunded
String

The total amount of the refund from this receiver.

PrimaryRecipient
boolean

Whether this recipient is the primary receiver.

If true, that means this refund is for a chained payment. If this field is set to false, this is a refund for a simple or parallel payment.

RecipientEmail
String

Email address of the receiver.

RefundStatus
String

Status of the refund.

The current PayPal return values are listed below:


REFUNDED	Refund successfully completed
REFUNDED_PENDING	Refund awaiting transfer of funds; for example, a refund paid by eCheck.
NOT_PAID	Payment was never made; therefore, it cannot be refunded.
ALREADY_REVERSED_OR_REFUNDED	Request rejected because the refund was already made, or the payment was reversed prior to this request.
NO_API_ACCESS_TO_RECEIVER	Request cannot be completed because you do not have third-party access from the receiver to make the refund.
REFUND_NOT_ALLOWED	Refund is not allowed.
INSUFFICIENT_BALANCE	Request rejected because the receiver from which the refund is to be paid does not have sufficient funds, or the funding source cannot be used to make a refund.
AMOUNT_EXCEEDS_REFUNDABLE	Request rejected because you attempted to refund more than the remaining amount of the payment. Use the AdaptivePaymentDetails component to determine the amount already refunded.
PREVIOUS_REFUND_PENDING	Request rejected because a refund is currently pending for this part of the payment
NOT_PROCESSED	Request rejected because it cannot be processed at this time
REFUND_ERROR	Request rejected because of an internal error
PREVIOUS_REFUND_ERROR	Request rejected because another part of this refund caused an internal error.

TotalOfAllRefunds
String

The total of all refunds actually paid.

This does not include pending amounts. This field is only returned when a partial refund has been requested.

TransactionAmount
String

Amount to be refunded to the receiver.

TransactionId
String

The encrypted PayPal transaction ID for this refund.

Note: This ID is different than the Transaction ID for the original payment.

TransactionStatus
String

The status of the refund transaction.

At the time of this writing, PayPal will only return "UNKNOWN" or "COMPLETED" in this field.

public RefundInfo();