UseePay Open API
UseePay PortalMechant Dashboard
Product Docs
Product Docs
  • V2.0
  • V1.0
UseePay PortalMechant Dashboard
Product Docs
Product Docs
  • V2.0
  • V1.0
  1. Payment Intents
  • Integration
    • Welcome to the UseePay Demo Page
    • Payment Product Overview
      • Hosted Checkout Integration Guide
      • Embedded Checkout Integration Guide
      • Express Checkout Integration Guide
      • Server to Server Integration Guide
    • About Payment Methods
      • Affirm
      • AfterPay_ClearPay
      • Bank Transfer
      • Boost
      • Card
      • Cashapp
      • Dana
      • GCash
      • iDEAL
      • Kakao Pay
      • Klarna
      • Konbini
      • Korean Card
      • Maya
      • Naver pay
      • Payco
      • Pay with Link
      • Pix
      • Pse
      • Samsung Pay
      • Tmoney
      • Toss Pay
      • Trustly
      • TrueMoney
      • RSA-Encrypted Card Payments
      • ApplePay
        • Apple Pay
        • Apple Pay Web Integration (API Integration)
      • GooglePay
        • Google Pay
        • Google Pay Web Integration (API Integration)
      • common
        • _shared-client-os-type
      • alipay
        • Alipay CN
        • Alipay HK
        • Alipay
    • Subscription
      • Get started with Subscription
    • Online payment
      • Get started with online payments
    • Payment Capabilities
      • Adaptive Price
      • Supported Payment Methods for Checkout
    • Checkout session
      • Checkout Session Guide
  • Developer
    • Introduction
    • Authentication
    • Integrate Local Payment Methods
    • Error code
      • last_payment_error documentation
      • Errors
    • Best Integration
      • Quickly create a paymentIntent for a subscription
      • Auto-Charge Subscription Guide
    • Payment Intents
      • Payment Intent Overview
      • Quickly create a paymentIntent
        POST
      • Create a PaymentIntent
        POST
      • Retrieve a PaymentIntent
        GET
      • Update a PaymentIntent
        POST
      • Confirm a PaymentIntent
        POST
      • Cancel a PaymentIntent
        POST
      • Capture a PaymentIntent
        POST
      • List all payment intents
        GET
    • Customers
      • Create a customer
      • Retrieves a customer
      • Update a customer
      • List all customers
    • Subscriptions
      • Create a subscription
      • Retrieves a subscription
      • Update a subscription
      • List all subscriptions
      • Cancel a subscription
    • Invoices
      • Create a invoice
      • Retrieves a invoice
      • List all invoices
      • Pay a invoice
    • Payment Methods
      • Retieve Payment Method Session
    • Mandates
      • Create a mandate
      • Retrieves a mandate
      • List all mandates
    • Refunds
      • Create a refund
      • Retrieves a refund
      • List all refunds
    • Webhooks
      • Webhook Integration Guide(version 2026-04)
      • Integration details
        • Supported Webhook Events
        • Webhook Activation/Signature Verification Steps
        • Webhook events for example
        • Dispute Webhook Integration Document
        • Difference between version 2026-04 and 2024-10-10
      • archive
        • 2024-10-10
          • Webhook Integration Guide(version 2024-10-10)
      • Create a webhook
      • Retrieves a webhook
      • Update a webhook
      • List all webhooks
    • Embedded Checkout
      • UseePay Elements Appearance
      • Payment Element
      • Payment Element (Deferred Intent)
      • Express Checkout Element
      • Checkout Session Element
    • Payment Method Configuration
      • Retieve Payment Method Configuration
    • Checkout Session
      • Create Checkout Session
      • Retrieve Checkout Session
    • Trackers
      • upload trackers
      • Retrieve a tracker
    • Capture
      • Capture Overview
      • List captures by intent id
    • Payement Attempt
      • ECI Indicator (3-D Secure) Reference
      • Retrieve PaymentAttempt
    • Schemas
      • CheckoutSessionCreateRequest
      • PaymentMethod
      • CreatePaymentIntentRequest
      • LineItem
      • Customer
      • Address
      • ProductData
      • Shipping
      • SubscriptionData
      • Error
      • DiscountPeriodConfig
      • DeviceData
      • CheckoutSessionResponse
      • ErrorResponse
      • Order
      • Product
      • PaymentMethodOptions
      • RiskControlOptions
      • Mandate
      • PaymentIntent
      • Billing
      • Card
      • AliPay
      • Wallet
      • Klarna
      • WechatPay
      • Refund
      • Subscription
      • Recurring
      • PriceData
      • SubscriptionItem
      • Invoice
      • NextAction
      • Webhook
      • CollectableOptions
      • PaymentLink
      • last_payment_error
      • discount_period_config
      • Capture
      • three_ds
      • PaymentAttempt
      • konbini
      • client_pm_options
      • pse
      • trial_period_config
      • Seller
  • Message
    • Messaging Element
  • About Testing
    • Test Cards
    • ApplePay&GooglePay
  • Reconciliation
    • SFTP Access for Reconciliation
  • FAQ
    • Unable to receive Webhook notifications
    • FAQ
    • Introduction
  1. Payment Intents

Payment Intent Overview

Payment Intent Status Flow Overview#

Automatic capture and manual capture#

A PaymentIntent supports two capture modes.
Capture modeConfigurationDescription
Automatic captureauto_capture=trueFunds are captured automatically after successful authorization
Manual captureauto_capture=falseFunds are authorized first and must be captured later
Some payment methods support a payment-method-specific capture setting under payment_method_options.
For Link, use:
{
  "payment_method_options": {
    "link": {
      "auto_capture": false
    }
  }
}
The payment-method-specific setting takes precedence over the top-level auto_capture setting.
If neither setting is provided, automatic capture is used.

Configure capture behavior by payment method#

When multiple payment methods are enabled for the same checkout, capture behavior can be configured separately for Link.
For example, the following configuration uses automatic capture by default but manual capture for Link:
{
  "auto_capture": true,
  "payment_method_options": {
    "link": {
      "auto_capture": false
    }
  }
}
In this example:
Link uses manual capture.
Other supported payment methods use the top-level automatic capture setting.

Manual capture status flow#

requires_payment_method
        ↓
requires_customer_action
        ↓
pending
        ↓
requires_capture
        ├── Capture → succeeded
        └── Cancel  → canceled
The intermediate requires_customer_action and pending statuses might not appear in every transaction.

requires_capture#

The requires_capture status means that the payment has been successfully authorized but has not yet been captured.
A PaymentIntent in this status is not a completed payment.
The merchant must perform one of the following actions:
Capture the full authorized amount.
Cancel the PaymentIntent and release the authorization.
Do not fulfill the order until the PaymentIntent reaches succeeded.
UseePay currently supports only one full capture. Partial capture and multiple captures are not supported.
Previous
Auto-Charge Subscription Guide
Next
Quickly create a paymentIntent
Built with