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. Webhooks
  • 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
      • Card
      • Apple Pay Web Integration (API Integration)
      • Google Pay Web Integration (API Integration)
      • Apple Pay(Hosted Checkout)
      • Google Pay
      • Klarna
      • Naver pay
      • Kakao Pay
      • Toss Pay
      • Payco
      • Affirm
      • Blik
      • Trustly
      • Cashapp
      • Pay with Link
    • 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
    • Errors
    • Error code
      • last_payment_error documentation
    • Best Integration
      • Quickly create a paymentIntent for a subscription
      • Auto-Charge Subscription Guide
    • Payment Intents
      • Payment Intent Overview
      • Quickly create a paymentIntent
      • Create a PaymentIntent
      • Retrieve a PaymentIntent
      • Update a PaymentIntent
      • Confirm a PaymentIntent
      • Cancel a PaymentIntent
      • Capture a PaymentIntent
      • List all payment intents
    • 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 Activation/Signature Verification Steps
      • Supported Webhook Events
      • Dispute Webhook Integration Document
      • 2026-04 coming soon
        • Webhook Request Format Update
        • Webhook events for example
      • Before 2026-04 supported
        • Webhook Events Documentation
        • Webhook events for example
      • Create a webhook
        POST
      • Retrieves a webhook
        GET
      • Update a webhook
        POST
      • List all webhooks
        GET
    • Embedded Checkout
      • Payment Element
      • Payment Element (Deferred Intent)
      • Express Checkout Element
      • Checkout Session Element
    • About Testing
      • Test Cards
      • ApplePay&GooglePay
    • 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
    • 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
  • Reconciliation
    • SFTP Access for Reconciliation
  • Message
    • Messaging Element
  • FAQ
    • Unable to receive Webhook notifications
  1. Webhooks

Supported Webhook Events

Supported Webhook Events#

The following webhook events are currently supported. Subscribe to them on your webhook endpoint via the events field (use ["*"] to subscribe to all).

Payment Intent#

EventDescription
payment_intent.createdA payment intent has been created.
payment_intent.requires_payment_methodThe payment intent is waiting for a payment method.
payment_intent.requires_customer_actionAdditional customer action is required (e.g. 3DS authentication).
payment_intent.requires_captureThe payment is authorized and awaiting capture.
payment_intent.pendingThe payment request has been accepted and is awaiting the final result.
payment_intent.succeededThe payment has completed successfully.
payment_intent.cancelledThe payment intent has been canceled.
payment_intent.failedThe payment intent has failed.

Refund#

EventDescription
refund.receivedThe refund request has been received and queued for processing.
refund.acceptedThe refund has been accepted by the provider and is now in progress. Final settlement timing depends on the issuing bank or payment method.
refund.succeededThe refund has completed successfully.
refund.failedThe refund has failed.

Subscription#

EventDescription
subscription.createdA subscription has been created.
subscription.activeThe subscription is now active.
subscription.pausedThe subscription has been paused.
subscription.unpaidThe subscription is unpaid due to outstanding invoices.
subscription.cancelledThe subscription has been canceled.
subscription.expiredThe subscription has expired.

Invoice#

EventDescription
invoice.sentThe invoice is ready to be paid.
invoice.paidThe invoice has been paid.
invoice.payment_failedInvoice payment has failed.
invoice.cancelledThe invoice has been canceled.

Checkout Session#

EventDescription
checkout_session.completedA checkout session has been completed successfully.
checkout_session.expiredA checkout session has expired before completion.

Dispute#

EventDescription
dispute.createdA dispute has been created.
dispute.closedA dispute has been closed.

Capture#

EventDescription
capture.succeededA capture succeeded.
capture.failedA capture failed.
Modified at 2026-04-28 07:32:42
Previous
Webhook Activation/Signature Verification Steps
Next
Dispute Webhook Integration Document
Built with