Payment Flow

Understand the complete payment lifecycle

Overview

A payment goes through several states from creation to completion. Understanding this flow is essential for building a robust integration.

Payment States

CREATED->PROCESSING->REQUIRES_ACTION->SUCCEEDED
StateDescription
CREATEDPayment intent has been created, awaiting payment method
PROCESSINGPayment is being processed with the provider
REQUIRES_ACTIONAdditional action required (e.g., 3DS, redirect)
SUCCEEDEDPayment completed successfully
FAILEDPayment failed (terminal state)
CANCELEDPayment was canceled (terminal state)

Typical Flow

  1. Create Payment Intent: Your server creates a payment intent with the amount and currency.
  2. Collect Payment Method: The user selects a payment method from the available options.
  3. Proceed with Payment: Your server submits the payment to our API.
  4. Handle Redirects: If 3DS or bank authentication is required, the user is redirected.
  5. Confirm Result: The payment completes and you receive a webhook notification.

Content Coming Soon

Detailed sequence diagrams and flow charts will be added in Phase 2.