RefundRefundStatus Property

Status of the refund.

Syntax

 adaptiverefund.getRefundRefundStatus(index, [callback])

Default Value

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getRefundRefundStatus([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setRefundRefundStatus([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

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 class 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.

The size of the array is controlled by the RefundCount property.

This property is read-only and not available at design time.

Data Type

String