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
    • 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
      • Payment Methods
        • Create a payment method
        • Retieve Payment Method Session
        • Retrieves a payment method
        • Update a payment method
        • List all payment methods
      • Mandates
        • Create a mandate
        • Retrieves a mandate
        • List all mandates
      • Refunds
        • Create a refund
        • Retrieves a refund
        • List all refunds
      • Webhooks
        • Webhook events
        • Webhook Activation/Signature Verification Steps
        • Webhook Events Documentation (testing)
        • Create a webhook
        • Retrieves a webhook
        • Update a webhook
        • List all webhooks
      • Embedded Checkout
        • Payment Elements
        • Express Checkout Elements
        • 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
    • message
      • Messaging Element
    • FAQ
      • Unable to receive Webhook notifications
    UseePay PortalMechant Dashboard
    Product Docs
    Product Docs
    • V2.0
    • V1.0
    UseePay PortalMechant Dashboard
    Product Docs
    Product Docs
    • V2.0
    • V1.0

    CreatePaymentIntentRequest

    {
        "merchant_order_id": "order_202601160001",
        "amount": 99.99,
        "currency": "usd",
        "customer": {
            "id": "cus_123",
            "email": "customer@example.com",
            "name": "John Doe",
            "phone": "+1234567890",
            "merchant_customer_id": "mcus_001",
            "property1": "string",
            "property2": "string"
        },
        "customer_id": "cus_123",
        "confirm": false,
        "auto_capture": true,
        "description": "Premium Monthly Plan",
        "device_data": {
            "browser": {
                "java_enabled": null,
                "javascript_enabled": null,
                "user_agent": "Apifox/1.0.0 (https://apifox.com)",
                "property1": "string",
                "property2": "string"
            },
            "language": "zh-CN,zh;q=0.9",
            "location": null,
            "mobile": null,
            "timezone": null,
            "accept_header": "*/*",
            "device_id": null,
            "ip_address": "127.0.0.1",
            "screen_color_depth": null,
            "screen_height": null,
            "screen_width": null,
            "property1": "string",
            "property2": "string"
        },
        "metadata": {
            "subscription_type": "premium",
            "billing_cycle": "monthly"
        },
        "order": {
            "category": "software",
            "products": [
                {
                    "id": "prod_001",
                    "name": "Premium Monthly Plan",
                    "code": "PMONTH",
                    "desc": "Unlimited access to premium features",
                    "effective_end_at": "2026-12-31T23:59:59Z",
                    "effective_start_at": "2026-01-01T00:00:00Z",
                    "quantity": 1,
                    "sku": "SKU-001",
                    "type": "intangible_good",
                    "price": 99.99,
                    "url": "https://example.com/product/premium",
                    "property1": "string",
                    "property2": "string"
                }
            ],
            "shipping": {
                "name": "John Doe",
                "phone": "+1234567890",
                "address": {
                    "line1": "456 Oak Avenue",
                    "line2": "Apt 5B",
                    "city": "Los Angeles",
                    "state": "CA",
                    "postal_code": "90001",
                    "country": "US",
                    "property1": "string",
                    "property2": "string"
                },
                "property1": "string",
                "property2": "string"
            },
            "property1": "string",
            "property2": "string"
        },
        "risk_control_options": {},
        "return_url": "https://example.com/pay/return",
        "mode": "subscription",
        "subscription_id": "sub_123",
        "invoice_id": "inv_123",
        "mandate_id": "mdt_123",
        "mandate_data": {},
        "payment_method_data": {
            "type": "card",
            "billing": {
                "name": "Premium User",
                "email": "dynamic_3d1@useepay.com",
                "phone": "+1234567890",
                "address": {
                    "line1": "123 Main Street",
                    "line2": "Suite 400",
                    "city": "New York",
                    "state": "NY",
                    "postal_code": "10001",
                    "country": "US",
                    "property1": "string",
                    "property2": "string"
                },
                "property1": "string",
                "property2": "string"
            },
            "card": {
                "number": "4242424242424242",
                "expiry_month": "12",
                "expiry_year": "2030",
                "cvc": "123",
                "property1": "string",
                "property2": "string"
            },
            "property1": "string",
            "property2": "string"
        },
        "payment_method_types": [
            "card"
        ],
        "property1": "string",
        "property2": "string"
    }
    Built with