Payment Life Cycle
Payment statuses are related to cart items rather than to the entire cart. This means that a cart can contain items with different payment statuses. Use the status request to find out the current item status.
Payment statuses (clickable)
initiated
The initiated status is the beginning of the payment life cycle. Cart items enter this state after a successful init request. At this point, the cart is created and the checkout form is delivered to the customer.
rejected
The customer attempted to make a payment, however, the verification server rejected the attempt. The possible reasons are insufficient funds on the customer's account or failed cardholder authentication.
expired
The expired status means that the time set in the cartExpiry property passed with the init request has elapsed. The possible reasons are that the customer decided no to proceed with the payment or was unable to do it.
The default value of the cartExpiry property depends on your agreement with OmniCart. If you have sufficient permissions, you can override the default cartExpiry value, although, it is not recommended.
Note that the cartExpiry property affects the entire cart, not specific items.
authorized
The authorized status means that both the verification service has successfully authenticated the customer and there was enough money in their account to make the payment.
The next status of the payment depends on whether one-step or two-step payment scheme is used.
One-Step Payment
In the one-stage scheme, the transaction is done immediately after authorization after which the payment enters the completed state. If you need to return the money to the customer at this point, use partial or complete refund. See also the Cancel and Refund section for more information.
Although, with one-step scheme, the payment stays in the authorized status for a very short time, the status request may still return this state.
Two-Step Payment
With the two-step scheme, after a payment has been authorized, the money is put on hold on the customer's account. This means that they cannot use it, although, the transaction is not completed yet. To complete the payment, use the capture request. Note that you do not have to capture all cart items in a single request.
Another option is to cancel the payment. By canceling a payment you release the customer's money that has been previously put on hold before the actual transaction is done. To cancel a payment, use the cancel request. Like with the capture request, you do not have to cancel all at once. In fact, you can capture a part of your cart and cancel the rest. See also the Cancel and Refund section for more information.
Depending on the OmniCart settings and your privileges, the payment may auto change its status to canceled or captured.
captured
A payment enters the captured status after you capture it using the capture request. A payment can also be auto captured if the OmniCart settings and your privileges allow that. After being captured, a payment is processed by OmniCart and automatically enters the completed status.
canceled
A payment enters the canceled state only after it has been fully canceled with the the cancel request. A payment can also be auto canceled if the OmniCart settings and your privileges allow that.
completed
The completed status means that the transaction is successfully done: the money is withdrawn from the customer's account and transferred to the target account. A payment enters this status after it has been auto processed by OmniCart following the authorized status in case of the one-step scheme and captured status in case of the two-step scheme. In this state, the payment may be fully or partially refunded.
In the case of a partial refund, the payment remains in the completed status. See also the Cancel and Refund section for more information.
refunded
The refunded status means that after a successful transaction the money has been transferred back to the customer's account from yours. A payment enters the refunded state only after it has been fully refunded using the refund request. Otherwise, the payment remains in the completed status. See also the Cancel and Refund section for more information.
ongoing
The ongoing status means that a payment is in an intermediate state. Some modify requests as well as partial cancellations or refunds might take longer to process that other requests. This status is also returned after the init request when customer action is required.