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

    {
    "id": "evt_5fcb36845625461794bfa8xxx",
    "name": "payment_intent.succeeded",
    "data": {
        "id": "10125082016088xxx",
        "amount": 50,
        "currency": "USD",
        "status": "succeeded",
        "customer": {
            "id": "cusxxx",
            "address": {
                "country": "CN",
                "city": "shanghai",
                "postcode": "200100",
                "state": "shanghai",
                "line1": "pudong zhangjiang",
                "line2": "room 1002"
            },
            "description": "test customer",
            "name": "??",
            "email": "xxx@useepay.com",
            "phone": "xx",
            "metadata": {
                "testkey": "12233"
            },
            "shipping": {
                "address": {
                    "country": "CN",
                    "city": "shanghai",
                    "postcode": "200100",
                    "state": "shanghai",
                    "line1": "minghang pushenglu",
                    "line2": "room 2002"
                },
                "name": "zhangsan",
                "phone": "13527189021"
            },
            "merchant_no": "50000000000xxxx",
            "app_id": "www.xxx.com",
            "create_at": "2025-08-20T08:08:50Z",
            "modify_at": "2025-08-20T08:08:50Z",
            "first_name": "??",
            "last_name": "",
            "merchant_customer_id": "10000202508201xxxx"
        },
        "description": "T-shirt",
        "order": {
            "category": "Apparel and accessories",
            "products": [
                {
                    "name": "IPHONE7",
                    "code": "12334455",
                    "desc": "IPHONE 7",
                    "quantity": 5,
                    "sku": "100004",
                    "type": "physical",
                    "url": "https://www.xxx.com/item/12345",
                    "effective_end_at": "2020-12-31T23:59:59Z",
                    "effective_start_at": "2020-01-01T00:00:00Z"
                }
            ],
            "shipping": {
                "address": {
                    "city": "Shanghai",
                    "postcode": "100000",
                    "state": "Shanghai",
                    "line1": "Pudong District"
                },
                "first_name": "John",
                "last_name": "Doe",
                "shipping_method": "sameday"
            }
        },
        "metadata": {
            "id": 1
        },
        "confirm": false,
        "orderType": "sale",
        "sale": true,
        "merchant_no": "50000000000xxxx",
        "app_id": "www.xxx.com",
        "create_at": "2025-08-20T08:08:54Z",
        "modify_at": "2025-08-20T08:09:43Z",
        "merchant_order_id": "2025082016085xxx",
        "invoice_id": "inv_xxx",
        "customer_id": "cus_xxx",
        "next_action": {
            "type": "redirect",
            "redirect": {
                "method": "GET",
                "url": "https://secure-auth.sandbox.useepay.com/threeDs?id=xxx",
                "content_type": "application/json"
            }
        },
        "return_url": "http://www.baidu.com",
        "client_secret": "xxx",
        "device_data": {
            "browser": {
                "java_enabled": false,
                "javascript_enabled": false,
                "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36"
            },
            "language": "EN or en-US",
            "location": {
                "lat": "-37.81892",
                "lon": "144.95913"
            },
            "mobile": {
                "device_model": "Apple IPHONE 7",
                "os_type": "IOS or ANDROID",
                "os_version": "IOS 14.5"
            },
            "timezone": "-2 or 3:30",
            "accept_header": "*/*",
            "device_id": "00000000-000000000000000",
            "ip_address": "xx.xx.xx.xx",
            "screen_color_depth": 24,
            "screen_height": 1080,
            "screen_width": 1920
        },
        "auto_capture": true,
        "mandate_id": "xxx",
        "last_payment_error": {},
        "order_id": "xxx"
    }
}

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": {}
  }
}

Dispute Events

Triggered when the checkout session status changes.

Event Names:

dispute.cteate - have a new dispute

Example:

{
    "eventId": "evt_121321313",
    "name": "dispute.create",
    "date": {
        "id": "202603311146012302",
        "object": "dispute",
        "payment_intent_id": "10113131321313325",
        "status": "need_reponse",
        "create_at": "2026-03-31T03: 31: 49Z",
        "modify_at": "2026-03-31T03: 31: 49Z",
        "merchant_order_id": "N20260331113148731118",
        "retrieval": false 
        "amount": 11,
        "currency": "USD",
        "reason": "product_not_received",
        "payment_method_details": {
	        "card": {
			"brand": "visa",
			"network_reason_code": "13.1"
		},
		"type": "card"
	}
    }
}

Event Types#

PaymentIntent Events#

Subscription Events#

Invoice Events#

Refund Events#

Checkout Session Events#

Dispute Events#

Event Types

PaymentIntent Events

Subscription Events

Invoice Events

Refund Events

Checkout Session Events

Dispute Events