OFPI Object States
Reference documentation for OFPI objects and their possible states
On this page we provide you with detailed flows of all the states that the following OFPI objects can go through:
- Charges
- Payment Intents
Charges
Below we outline the various states in the OFPI charge process, detailing the possible transitions between these states and describing the conditions under which these transitions occur. Please see the table below to get a comprehensive overview of each state and the flow of the charge process.
![](https://files.readme.io/ab74429-ofpi-charge-states.png)
State | Description | Transitions to | Trigger/Event |
---|---|---|---|
CREATED | Initial state when the charge is created. | - PENDING | - Charge is initiated but not yet processed by the OF network |
PENDING | The charge is awaiting further action or scheduling. | - SCHEDULED - SUCCEEDED - CANCELED - FAILED | - Charge is scheduled for processing - The Charge has successfully been processed in the OF netowrk - Charge is canceled by OF network while pending - Charge fails in the OF network while pending. |
SCHEDULED | The charge is scheduled for processing at a future date. | - SUCCEEDED - CANCELED - FAILED | - Charge is successfully processed - Charge is canceled while scheduled - Charge fails while scheduled. |
SUCCEEDED | The charge has been successfully processed. | (End state - no further transitions) | - |
CANCELED | The charge has been canceled. | (End state - no further transitions) | - |
FAILED | The charge has failed. | (End state - no further transitions) | - |
Payment Intents
Below we outline the various states in the OFPI payment intent process, detailing the possible transitions between these states and describing the conditions under which these transitions occur. Please see the table below to get a comprehensive overview of each state and the flow of the payment intent process.
![](https://files.readme.io/6e10326-ofpi-payment-intent-states.png)
State | Description | Transitions to | Trigger/Event |
---|---|---|---|
Created & Confirmed | Initial state when the payment intent is created and is confirmed by the user in the customer's flow. | - REQUIRES_ACTION | - Payment intent is created and confirmed. |
REQUIRES_ACTION | The payment intent requires further action. | - PROCESSING - FAILED | - Payment intent contains all required information - Payment intent fails (for example, the user did not grant their consent in the banking application). |
PROCESSING | The payment intent is being processed. | - SCHEDULED - SUCCEEDED - CANCELED - FAILED | - Payment intent moves to scheduled state - Payment intent is successfully processed - Payment intent is canceled - Payment intent fails. |
SCHEDULED | The payment intent is scheduled for processing. | - SCHEDULE_FINISHED - CANCELED | - Payment intent completes schedule payments - Payment intent is canceled. |
SCHEDULE_FINISHED | The payment intent has finished the scheduled processing. Only used if not 100% of a schedule succeeded. Otherwise the final status is SUCCEEDED . | (End state - no further transitions) | - |
SUCCEEDED | The payment intent has been successfully processed. | (End state - no further transitions) | - |
CANCELED | The payment intent has been canceled. | (End state - no further transitions) | - |
FAILED | The payment intent has failed. | (End state - no further transitions) | - |
Updated 6 days ago