Skip to main content
knowledgecenter.2checkout.com

Order flow in 2Checkout API

Overview

Order flow in the 2Checkout system is complex no matter what type of integration you choose. Find out more information below on order lifecycle, order statuses, chargeback flow, and user interfaces.

Order lifecycle

Diagram #1 order flow.png

Order statuses

Order status

The overall status of an order in the 2Checkout systems.

Status value Description

PENDING

2Checkout has yet to block the amount corresponding to the transaction or shoppers used an offline payment method like a wire transfer.

AUTHRECEIVED

2Checkout blocks the amount corresponding to the transaction, but the process of collecting funds is incomplete.

COMPLETE

 The shopper completed the transaction for the purchase and 2Checkout or you fulfilled the order (when required).

REVERSED

Payment authorization has been reversed due to being flagged as potentially fraudulent but the order has not been canceled. The shopper can retry payment in order to complete the order.

REFUND

2Checkout refunds orders only after they reach the Complete/Finished stage and returns the funds collected to shoppers.

 

CANCELED

Order has been canceled by the merchant (for partner orders) or by 2Checkout (order not paid when offline payment methods are used).

PENDING

2Checkout has yet to block the amount corresponding to the transaction or shoppers used an offline payment method like a wire transfer.

Merchant Approve Status

Shows if the merchant has approved or not a partner order. 

Merchant approve status Description

OK

Order approved.

WAITING

Order is awaiting a decision. While it depends on the load on the Fraud flow, orders get approved within a matter of minutes.

REJECTED

Order canceled.

Approve Status

The status of the order resulted from the evaluation by the 2Checkout anti-fraud system or by a member of the anti-fraud department. This status varies for new purchases and for orders requiring customers to make manual payments.

Usually, an order will be approved anywhere between a few seconds to a couple of minutes. The approval time depends on a few factors, like the data provided by the shopper (that is used to calculate the risk score), as well as the “age” of the merchant. In the first month, the orders of a new merchant will take a little longer to be authorized by the Risk team.

Approve Status Values Description

WAITING

The 2Checkout Anti-Fraud System or a member of the Anti-Fraud Department has yet to approve the order.

INVALIDATA

Shopper-supplied data is invalid – 2Checkout did not approve the order.

FRAUD

The 2Checkout Anti-Fraud System or a member of the Anti-Fraud Department has flagged the order as being fraudulent.

Usually, there is nothing the merchant can do. The 2Checkout Risk department will contact the shopper in order to confirm the order.

If the shopper confirms the order, then the status is updated to OK.

OK

The 2Checkout Anti-Fraud System or a member of the Anti-Fraud Department approved the order.

Chargeback flow 

Chargebacks are shopper requests for funds reversal made directly to the bank/PayPal, possible only if the payment was made using a credit/debit card or PayPal. As a rule of thumb, buyers contact their credit card bank/issuer or PayPal directly to initiate a chargeback. You can read more on chargebacks here.

Diagram #2.png

Chargeback Resolution

Chargeback Resolution Status Description

OPEN

A chargeback has been raised on the order and is in progress.

WON

The chargeback raised on the order has been won by the merchant.

LOST

The chargeback raised on the order has been won by the shopper.

ACCEPTED

The chargeback process has been closed. The merchant agreed to repay the value of the order to the customer

User Interfaces

Merchant Control Panel

The Merchant Control Panel Dashboard acts as a homepage and comes with a wide array of functionalities that allow live monitoring of the main business metrics, customization, and extended reporting capabilities.

While working on your integration, the Merchant Control Panel offers the easy to use interface for debugging and testing your integration.

Shopping Carts

Several cart options are available, based on the required use cases needed and desired behavior.

ConvertPlus is the newest and main cart in the 2Checkout system. ConvertPlus simplifies the process of collecting payments from shoppers using major credit/debit cards as well as localized payment methods and can be used in sync with the API for managing the product catalog, fetching order information, and more. 

The InLine Checkout acts as an iframe that opens on your website, enabling you to receive payments without redirecting your customers to a third party checkout. Inline Checkout integrates ideally with shopping cart applications that collect customer billing and shipping information, allowing you to pass that information over to the cart and minimize customer's efforts during the payment process.

API

The 2Checkout Public API is the main interface for interacting with the 2Checkout systems in a programmatic way. Offering a wide range of functionality, the API is available in a number of protocols and versions.     

Webhooks 

2Checkout generates automatic notifications for transaction and subscription/license change events which it sends to a location on your server you control via Webhooks. 

Using this webhooks, you can perform backend tasks including provisioning, entitlement, customer, and subscription lifecycle management.

The available webhooks are:

Depending on the order status, approval status, and order flow, there are different ways these map to the IPN status:

IPN Message Type Merchant Control Panel Trigger Order Status Description

PENDING

Pending orders.

PENDING

Shopper places the order. 2Checkout is waiting for bank authorization.

PENDING

Pending orders.

PURCHASE_PENDING

Shopper places the order using a Purchase Order (PO). 2Checkout approves the PO document and you also approve the PO document. Shopper has yet to finalize the payment.
 
Alternatively, you use the AutoApprove API flow and do not require a PO document but the shopper has yet to finalize the payment.

PROCESSING

Orders waiting to be processed by 2Checkout system.

PENDING_APPROVAL

Order is waiting for the 2Checkout system to process it or for anti-fraud review.

APPROVED

Authorized and approved orders (sent before electronic delivery).

PAYMENT_AUTHORIZED

The bank authorized the payment.

APPROVED

Authorized and approved orders (sent before electronic delivery).

PAYMENT_RECEIVED

2Checkout sends a notification when it receives payments for offline orders (e.g. Bank/Wire transfer) but only before fulfillment/delivery.

APPROVED

Authorized and approved orders (sent before electronic delivery).

PENDING_ORDER_APPROVAL

2Checkout sends this status for products/subscriptions configured with the “Requires delivery confirmation” setting.

AUTH

Authorized and approved orders (sent after electronic delivery).

PAYMENT_AUTHORIZED

The bank authorized the payment.

AUTH

Authorized and approved orders (sent after electronic delivery).

COMPLETE

2Checkout marks the order as finished and fulfilled.

APPROVED_DELIVERY

Order approved for delivery.

PAYMENT_AUTHORIZED

You approved an order for fulfillment/delivery.

COMPLETE

Completed orders.

COMPLETE

2Checkout marks the order as finished and fulfilled.
 
2Checkout can resend this notification when it generates invoices.

COMPLETE

Completed orders.

COMPLETE

Customer pays the PO.

ORDER_UNDER_REVIEW

Orders under 2Checkout review.

PENDING_APPROVAL

Order is waiting for the 2Checkout system to process it or for anti-fraud review.

SHOPPER_INVOICE

Invoice generated.

COMPLETE

2Checkout marks the order as finished and fulfilled.
 
2Checkout can resend this notification when it generates invoices.

SUSPECT

Fraud suspect.

SUSPECT

The 2Checkout Risk department is reviewing the order for possible fraud. (Not available by default, contact 2Checkout directly to enable it)

CANCELED

Canceled orders.

CANCELED

The 2Checkout system can send out notifications for:
eStore orders canceled by 2Checkout representatives (only for orders that are not authorized/paid, otherwise a reverse or refund action is required).
Partner (Channel Manager) orders canceled by you.
Purchase Orders not approved/submitted in due time

CHARGEBACK_OPEN

Chargeback open.

COMPLETE

ORDERSTATUS is COMPLETE for chargebacks. 2Checkout details information about disputes in the CHARGEBACK_RESOLUTION and CHARGEBACK_REASON_CODE fields.

CHARGEBACK_CLOSED

Chargeback closed.

COMPLETE

ORDERSTATUS is COMPLETE for chargebacks. 2Checkout details information about disputes in the CHARGEBACK_RESOLUTION and CHARGEBACK_REASON_CODE fields.
 
2Checkout can resend this notification when it generates chargeback invoices.

REFUND

Reversed and refund orders.

REVERSED

2Checkout reverses transactions and releases funds back to shoppers for Authorized payments that never reach the Complete status.

REFUND

Reversed and refund orders.

REFUND

2Checkout repays funds back to shoppers for Complete orders.
 
2Checkout can resend this notification when it generates refund invoices.

PURCHASE_PENDING

Approved

PURCHASE_PENDING

You approve the PO document.

PURCHASE_REJECTED_BY_VENDOR

Rejected

CANCELED

You reject the PO document.

PURCHASE_COMPLETE

Completed

COMPLETE

Customer pays the PO.

PURCHASE_EXPIRED_NOT_PAID

Expired, not paid

CANCELED

You don’t approve nor reject the PO within a time interval.

PURCHASE_CANCELED_TIMEOUT

Canceled

CANCELED

You cancel the PO or 2Checkout cancels the order.

PENDING_APPROVAL_ORDER_FOR_PARTNER

Pending approval orders from partners.

PENDING

Resellers place orders that await your approval.

VENDOR_APPROVED

Approved orders from partners.

PENDING

You approve partner orders.

DELIVERED_ORDER_FOR_PARTNER

Delivered orders from partners.

PENDING

2Checkout fulfills partner orders.

ORDER_SHIPPED

Order shipped (only for tangible products)

PAYMENT_AUTHORIZED

You marked the order as shipped, and the delivery process has started.
2Checkout sends a notification to customers once orders are marked as shipped.

INVALID

Invalid orders

INVALID

Shopper provides invalid billing and/or delivery information. (Not available by default, contact 2Checkout directly to enable it)

2Checkout also provides the following webhooks:

You can read the complete information about webhooks here.

  • Was this article helpful?