PaymentStatus Property

The status of the payment.

Syntax

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

The current list of possible values include:


CREATED	The payment request was received; funds will be transferred once the payment is approved.
COMPLETED	The payment was successful.
INCOMPLETE	Some transfers succeeded and some failed for a parallel payment.
ERROR	The payment failed and all attempted transfers failed or all completed transfers were successfully reversed.
REVERSALERROR	One or more transfers failed when attempting to reverse a payment.
PROCESSING	The payment is in progress.
PENDING	The payment is awaiting processing responseEnvelope Common response information, including a timestamp and.

This property is read-only.

Data Type

String