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
    • About Payment Methods
      • Card
      • Apple Pay Web Integration (API Integration)
      • Apple Pay(Hosted Checkout)
      • Google Pay
      • Klarna
      • Naver pay
      • Kakao Pay
      • Toss Pay
      • Payco
      • Affirm
      • Blik
      • trustly
      • Cashapp
    • 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
    • Mandates
      • Create a mandate
      • Retrieves a mandate
      • List all mandates
    • Refunds
      • Create a refund
      • Retrieves a refund
      • List all refunds
    • Webhooks
      • Webhook Events Documentation
      • Webhook events for example
      • Webhook Activation/Signature Verification Steps
      • 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
    • case
    • objects
    • 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
    • Schemas
      • CheckoutSessionCreateRequest
      • LineItem
      • Customer
      • Address
      • ProductData
      • Shipping
      • SubscriptionData
      • Error
      • DiscountPeriodConfig
      • DeviceData
      • CheckoutSessionResponse
      • ErrorResponse
      • Order
      • Product
      • PaymentMethodOptions
      • RiskControlOptions
      • Mandate
      • PaymentIntent
      • PaymentMethod
      • Billing
      • Card
      • AliPay
      • Wallet
      • Klarna
      • WechatPay
      • Refund
      • Subscription
      • Recurring
      • PriceData
      • SubscriptionItem
      • Invoice
      • NextAction
      • Webhook
      • CollectableOptions
      • PaymentLink
      • last_payment_error
      • discount_period_config
      • CreatePaymentIntentRequest
  • Reconciliation
    • SFTP Access for Reconciliation
  • message
    • Messaging Element
  • FAQ
    • Unable to receive Webhook notifications
  1. Webhooks

Webhook events for example

Event Types#

PaymentIntent Events#

Triggered when the payment intent status changes.
Event Names:
payment_intent.created - Payment intent created
payment_intent.requires_payment_method - Requires payment method
payment_intent.requires_capture - Requires capture
payment_intent.requires_customer_action - Requires customer action
payment_intent.pending - Processing
payment_intent.succeeded - Payment succeeded
payment_intent.cancelled - Cancelled
payment_intent.failed - Payment failed
Data Object: PaymentIntent
Example:
{
  "id": "evt_79bdd43e4d0f464694fa433a5d467980",
  "name": "payment_intent.succeeded",
  "data": {
    "id": "pi_1234567890",
    "object": "payment_intent",
    "amount": 10000,
    "currency": "USD",
    "status": "succeeded",
    "customer_id": "cus_abc123",
    "merchant_no": "500000000013102",
    "app_id": "www.A07.com",
    "merchant_order_id": "order_1740723761000",
    "payment_method": {
      "type": "card",
      "card": {
        "brand": "visa",
        "last4": "4242"
      }
    },
    "created_at": "2024-01-27T10:30:00Z",
    "metadata": {}
  }
}
Webhook Example for PaymentIntent.succeeded

Subscription Events#

Triggered when the subscription status changes.
Event Names:
subscription.created - Subscription created
subscription.active - Subscription activated
subscription.updated - Subscription updated
subscription.unpaid - Unpaid
subscription.paused - Paused
subscription.cancelled - Cancelled
subscription.expired - Expired
Data Object: Subscription
Example:
{
  "id": "evt_abc123def456",
  "name": "subscription.active",
  "data": {
    "id": "sub_9876543210",
    "object": "subscription",
    "status": "active",
    "customer_id": "cus_abc123",
    "merchant_no": "500000000013102",
    "app_id": "www.A07.com",
    "current_period_start": "2024-01-27T00:00:00Z",
    "current_period_end": "2024-02-27T00:00:00Z",
    "recurring": {
      "interval": "month",
      "interval_count": 1,
      "unit_amount": 9900
    },
    "created_at": "2024-01-27T10:30:00Z",
    "metadata": {}
  }
}

Invoice Events#

Triggered when the invoice status changes.
Event Names:
invoice.sent - Invoice sent
invoice.paid - Invoice paid
invoice.payment_failed - Payment failed
invoice.cancelled - Invoice cancelled
Data Object: Invoice
Example:
{
  "id": "evt_invoice123",
  "name": "invoice.paid",
  "data": {
    "id": "inv_1122334455",
    "object": "invoice",
    "status": "paid",
    "customer_id": "cus_abc123",
    "subscription_id": "sub_9876543210",
    "merchant_no": "500000000013102",
    "app_id": "www.A07.com",
    "total_amount": 9900,
    "currency": "USD",
    "period_start": "2024-01-27T00:00:00Z",
    "period_end": "2024-02-27T00:00:00Z",
    "payment_intent_id": "pi_1234567890",
    "created_at": "2024-01-27T10:30:00Z",
    "metadata": {}
  }
}
Example for invoice.paid

Refund Events#

Triggered when the refund status changes.
Event Names:
refund.received - Refund request received
refund.accepted - Refund accepted
refund.succeeded - Refund succeeded
refund.failed - Refund failed
Data Object: Refund
Example:
{
  "id": "evt_refund789",
  "name": "refund.succeeded",
  "data": {
    "id": "ref_9988776655",
    "object": "refund",
    "status": "succeeded",
    "amount": 5000,
    "currency": "USD",
    "payment_intent_id": "pi_1234567890",
    "merchant_no": "500000000013102",
    "app_id": "www.A07.com",
    "reason": "requested_by_customer",
    "created_at": "2024-01-27T10:30:00Z",
    "metadata": {}
  }
}

Checkout Session Events#

Triggered when the checkout session status changes.
Event Names:
checkout_session.completed - Checkout completed
checkout_session.expired - Session expired
Example:
{
  "id": "evt_checkout456",
  "name": "checkout_session.completed",
  "data": {
    "id": "cs_6677889900",
    "object": "checkout.session",
    "mode": "subscription",
    "status": "complete",
    "payment_status": "paid",
    "customer_id": "cus_abc123",
    "subscription_id": "sub_9876543210",
    "payment_intent_id": "pi_1234567890",
    "amount": 9900,
    "currency": "USD",
    "created_at": "2024-01-27T10:30:00Z",
    "metadata": {}
  }
}
Modified at 2026-03-19 10:41:13
Previous
Webhook Events Documentation
Next
Webhook Activation/Signature Verification Steps
Built with