diff --git a/api-reference/introduction.mdx b/api-reference/introduction.mdx index 568e50ace7..03f87c24b4 100644 --- a/api-reference/introduction.mdx +++ b/api-reference/introduction.mdx @@ -69,10 +69,20 @@ Hyperswitch handles the complex functionality of a comprehensive payments flow t | processing | In case of automatic capture, the payments object transitions to processing state post confirm call and subsequent customer authentication if available. | | succeeded | The payments object reaches success state post confirmation of successful processing from the payment processor. | | failed | The payments object transitions to a failed state when the payment processor confirms the processing failure. | -| expired | You can expire the payments object while it is in any state except when it is under ‘processing’ or ‘succeeded’ state. | ![](assets/images/image.png) +## Payment Lifecycle - more payment states + +| Payment Status | Description | +| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Merchant Action Required | The payment is waiting on some action from the merchant (e.g., manual fraud approval) | +| Partially Captured | The payment has been captured partially, and the remaining amount cannot be captured | +| Partially Captured and Capturable | The payment has been captured partially and the remaining amount is capturable | +| Partially Authorized and Requires Capture | The payment has been authorized for a partial amount and requires capture | +| Conflicted | There has been a discrepancy between the amount/currency sent in the request and the amount/currency received by the processor. Applicable for Crypto payments and Bank transfer payments (EU) where user can change the amount on Bank page | +| Expired | The payment expired before it could be captured | + ## Redirect URL This is what a url looks like after redirection @@ -85,4 +95,4 @@ The available parameters are as follows: - **payment_intent_client_secret** - This is the client secret associated with the payment. This can be used to retrieve the payment status from hyperswitch. - **manual_retry_allowed** - whether this payment can be retried or not. - **signature** - A HMAC signature of the payload, this can be verified using the `payment_response_hash_key`. -- **signature_algorithm** - The HMAC algorithm used to calculate the signature. \ No newline at end of file +- **signature_algorithm** - The HMAC algorithm used to calculate the signature.