These are the statuses returned by the order payment API and the values displayed when merchant integrators retrieve (GET
) a transaction via the API.
Note: our dashboards in most cases map these statuses to different values, but only for display purposes.
paid |
This payment is successful and funds have been collected. |
pending |
This payment is successful, funds have been collected from the customer, but they are pending being transferred to the merchants balance. This status is currently only used by PayPlan's since we delay the transfer of funds into a merchants balance. This means that transactions in this state are not paid out in the same window of time as paid transactions. |
refunded |
A full refund has been initiated on this payment. |
partially_refunded |
A partial refund of the original payment amount has been initiated on this payment. |
failed |
The attempt to collect funds from the payment method was not successful. |
cancelled |
This payment has been cancelled. |
disputed |
At least one charge on the payment method has been disputed. |
not_captured |
The payment method has been authorised but funds are not yet captured. |
incomplete |
This payment has not been completed by the customer. Currently, a transaction is only incomplete if 3DS authentication has not yet been completed. If the customer does not complete the authentication, the transaction will stay in this state. |