DocumentationAPI Reference
API Reference

Transaction states

This topic explains the different transaction states, their descriptions, and the actions associated with each state.

Order states

The following order state diagram shows the sequence of states an order progresses through during its lifecycle. It shows the possible statuses and actions through each stage, allowing you to track an order's progress through payment capture.

1320

The following table provides a brief overview of the order states that a merchant may encounter.

StateDescription
PendingThis transient state occurs when the order waits for a payment attempt.
Processing*A payment attempt that requires external authentication, such as PayPal, is currently in progress.
PaymentAuthorized*Payment has been authorized. If the order is not under review, the payment capture can proceed.
Processed*The request successfully completed the payment for the order.
ProcessingFailed*The payment attempt for the order was unsuccessful.
Cancelled*The merchant explicitly cancelled the order, or it expired before being captured.
Declined*The manual fraud review declined the order.

* When this state occurs, it sends an asynchronous notification.

Refund states

The following refund state diagram shows the sequence of states a refund progresses through during its lifecycle. It outlines the possible statuses and actions at each stage, making tracking a refund's progress easier.

🚧

Refund states are independent of the state of the order the refund is associated with.

👍

Attempting to process a refund again after an initial failure may or may not be successful. Reach personnel are notified and investigate each refund failure.

780

The following table provides a brief overview of the order states that a merchant may encounter.

StateDescription
InProgressThe refund is still pending.
Succeeded*The refund succeeded.
Failed*The refund failed.

* When this state occurs, it sends an asynchronous notification.

Fraud states

The following fraud state diagram shows the sequence of states a fraud review progresses through during its lifecycle. It shows the possible statuses and actions through each stage, allowing you to track a fraud review's progress.

780

Fraud reviews

Reach's fraud team initiates and resolves fraud reviews. Review states are independent of the state of the order. The following table provides a brief overview of the fraud review states that a merchant may encounter.

StateDescription
TrueThe payment attempt is under review.
FalseThe payment attempt is not under review.

Notification events

The fraud review will send notifications when the following events occur.

EventDescription
Order Under ReviewThe payment attempt is under review. Fulfillment should not continue regardless of the state of order.
Order ApprovedThe fraud review approved the payment attempt and is no longer under review. Fulfillment may continue if the order is completed.
Order DeclinedThe fraud review declined the payment attempt and set the order state to Declined. Fulfillment should not continue.

Contract states

The following contract state diagram shows the sequence of states a contract progresses through during its lifecycle. It shows the possible statuses and actions through each stage, allowing you to track a contract's progress.

780

The following table provides a brief overview of the contract states that a merchant may encounter.

StateDescription
Open*The contract is currently open, and you can use the associated ContractId in subsequent /create, /checkout, and /authorize requests.
Closed*The contract is closed, and you can no longer use the ContractId for new orders.

* When this state occurs, it sends an asynchronous notification.