RefundType Property
Identifies the supported types of refund transactions.
Syntax
refundtransaction.getRefundType([callback]) refundtransaction.setRefundType( refundType, [callback])
Possible Values
0 (rtFull), 1 (rtPartial)
Default Value
0
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 getRefundType([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 setRefundType([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
There are two types of refund transactions:
| rtFull (0) | A full refund of the purchase. The contents of Amount are ignored. |
| rtPartial (1) | Partial refund of the purchase. CurrencyCode and Amount are required, and must be less than the original transaction amount. |
Data Type
Integer