States and notifications
This guide describes the sessions, orders, and notification states and explains how a merchant receives notifications using the Drop-In API.
Session state
| Value | Final State? | Description |
|---|---|---|
| CREATED | No | The session was initiated using the Create Session endpoint. A shopper may attempt payment using the Drop-In. |
| PROCESSING | No* | A short-lived state signifying a payment attempt is being processed. |
| REDIRECTED | No | This state indicates Drop-In redirected the shopper to the payment provider to complete the payment. |
| COMPLETED | Yes | This final state signifies that the user has completed interacting with the Drop-In and Drop-In has created an order. |
| CANCELLED | Yes | This final state indicates a merchant has requested the cancellation of a CREATED Session. |
| FAILED | Yes | This final state signifies that something has gone wrong while the user tried completing the payment. |
*PROCESSING transactions will transition to another state automatically without user input.
Order states
| Description | |
|---|---|
| Processing | A payment attempt requiring external action (e.g., Bank Transfer). |
| PaymentAuthorized | The payment provider authorized the payment. If the order is not under review, payment capture may proceed. |
| Processed | Payment for the order has completed successfully. |
| ProcessingFailed | The last payment attempt for the order was not successful. |
| Cancelled | The merchant canceled the order explicitly, or the order expired before being captured. |
| Declined | Reach declined the order as a result of a manual fraud review. |
Refund states
Refund states represent the current state of a refund as it moves through its lifecycle in a payment or order management system. These states help track, manage, and automate the refund process, ensuring accurate reporting and compliance. These states are independent of the state of the order the refund is associated with.
Best practice
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. Give Reach time to investigate the refund failure before trying again.
| State | Description |
|---|---|
| InProgress | The refund is still pending. |
| Succeeded* | The refund succeeded. |
| Failed* | The refund failed. |
* Drop-In API sends asynchronous notifications when this state occurs.
Notifications
Notification events are sent to merchants via asynchronous HTTP POST requests to synchronize the merchant's payment information with Reach's information. Technical information about the notification structure is available in the Drop-In API notifications guide.
Updated about 18 hours ago