PaymentStatus Property
Status of the payment.
Syntax
ipn.getPaymentStatus([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 getPaymentStatus([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 setPaymentStatus([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 payment.
The current list of possible values for this property are:
| Response | Description |
| None | No status. |
| Canceled-Reversal | A reversal has been canceled. |
| Completed | The payment has been completed and the funds have been added successfully to your account balance. |
| Denied | You denied the payment. |
| Failed | The payment has failed. |
| Pending | The payment is pending. |
| Refunded | You refunded the payment. |
| Reversed | A payment was reversed due to a chargeback or other type of reversal. The funds have been removed from your account balance and returned to the buyer. |
| Processed | A payment has been accepted. |
- "Canceled-Reversal": it means that a reversal has been canceled. For example, you won a dispute with the customer, and the funds for the transaction that was reversed have been returned to you.
- "Denied": this happens only if the payment was previously pending because of possible reasons described for the PendingReason element.
- "Failed": this happens only if the payment was made from your customer's bank account.
- "Pending": see the PaymentPendingReason property for more information.
This property is read-only.
Data Type
String