Create a PaymentIntent

Useepay API V2.0 Sandbox Environment

https://openapi1.uat.useepay.com

POST

/api/v1/payment_intents/create

Creates a PaymentIntent object.
After the PaymentIntent is created, attach a payment method and confirm to continue the payment.

When you use confirm=true during creation, it’s equivalent to creating and confirming the PaymentIntent in the same call. You can use any parameters available in the confirm API when you supply confirm=true.

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

🟠400Base Request

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://openapi1.uat.useepay.com/api/v1/payment_intents/create' \
--header 'x-merchant-no: 500000000007245' \
--header 'x-api-key: FUYTIUvjhgfytfuytwiue' \
--header 'x-app-id: www.pay.com' \
--header 'x-api-version: 2024-08' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 100.23,
    "currency": "USD",
    "merchant_order_id": "72934khwqjry09ew807",
    "customer": {
        "email": "test@useepay.com",
        "first_name": "zhang",
        "last_name": "shan",
        "phone": "+8613624569293",
        "address": {
            "country": "US",
            "city": "New York",
            "state": "NY",
            "postcode": "100000",
            "line1": "Pudong District"
        },
        "merchant_customer_id": "cust00002"
    },
    "customer_id": "cus_1JA7UDDQG3800",
    "payment_method_id": null,
    "confirm": false,
    "auto_capture": false,
    "description": "T-shirt",
    "device_data": {
        "accept_header": "*/*",
        "browser": {
            "java_enabled": false,
            "javascript_enabled": true,
            "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"
        },
        "device_id": "00000000-000000000000000",
        "ip_address": "212.121.222.123 or 2001:0db8:0000:0000:0000:ff00:0042:8329",
        "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"
        },
        "screen_color_depth": 24,
        "screen_height": 1080,
        "screen_width": 1920,
        "timezone": "-2 or 3:30"
    },
    "metadata": {
        "id": 1
    },
    "order": {
        "category": "Apparel and accessories",
        "products": [
            {
                "category": "Apparel and accessories",
                "code": "12334455",
                "desc": "IPHONE 7",
                "effective_end_at": "2020-12-31T23:59:59Z",
                "effective_start_at": "2020-01-01T00:00:00Z",
                "name": "IPHONE7",
                "quantity": 5,
                "seller": {
                    "identifier": "string",
                    "name": "string"
                },
                "sku": "100004",
                "type": "physical",
                "price": 100.01,
                "url": "https://www.xxx.com/item/12345"
            }
        ],
        "shipping": {
            "address": {
                "city": "Shanghai",
                "country": "CN",
                "postcode": "100000",
                "state": "Shanghai",
                "line1": "Pudong District",
                "line2": "Zhejiang District"
            },
            "first_name": "John",
            "last_name": "Doe",
            "phone": "13800000000",
            "shipping_method": "sameday"
        }
    },
    "payment_method_options": {
        "type": "alipay_cn",
        "alipay_cn": {
            "os_type": "IOS",
            "client": "WEB",
            "flow": "redirect"
        }
    },
    "return_url": "http://www.example.com",
    "risk_control_options": {
        "skip_risk_processing": false,
        "tra_applicable": false
    },
    "invoice_id": "inv_1JBQUCEC40000",
    "mandate_id": null,
    "mandate_data": {
        "customer_acceptance": {
            "type": "online",
            "accepted_at": "2024-10-06T10:56:21Z",
            "online": {
                "ip_address": "192.168.12.1",
                "user_agent": "user agent"
            }
        }
    },
    "payment_method_types": [
        "card",
        "google_pay",
        "apple_pay"
    ]
}'

Response Example

200 - Success

{
    "id": "1012607101735137723",
    "code": "0000",
    "message": "Approved or completed successfully",
    "amount": 30,
    "currency": "USD",
    "status": "succeeded",
    "description": "T-shirt",
    "order": {
        "category": "Apparel and accessories",
        "products": [
            {
                "id": null,
                "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",
                "price": null
            }
        ],
        "sellers": null,
        "shipping": {
            "address": {
                "country": "US",
                "city": "New York",
                "postcode": "10001",
                "state": "NY",
                "line1": "123 Broadway",
                "line2": null
            },
            "name": null,
            "phone": null,
            "first_name": "John",
            "last_name": "Doe",
            "shipping_method": "sameday"
        }
    },
    "confirm": true,
    "orderType": "sale",
    "mode": "payment",
    "sale": true,
    "merchant_no": "500000000008901",
    "app_id": "www.pay.com",
    "create_at": "2026-07-10T09:35:45Z",
    "modify_at": "2026-07-10T09:35:45Z",
    "merchant_order_id": "b4ca2a45-200d-4b9f-9e79-eb23038eb5e2",
    "refunded_amount": 0,
    "return_url": "https://api.webhookinbox.com/i/YhxDlEgC/in/",
    "client_secret": "e273af7e1453db139511b4f8633d1a91",
    "auto_capture": true,
    "order_id": "1012607101735137724",
    "latest_payment_attempt": "pa_13AL5HGU14800",
    "payment_attempt": {
        "id": "pa_13AL5HGU14800",
        "billing": {
            "address": {
                "country": "US",
                "city": "New York",
                "postcode": "10001",
                "state": "NY",
                "line1": "123 Broadway",
                "line2": null
            },
            "email": "dynamic_d@useepay.com",
            "name": null,
            "phone": null,
            "date_of_birth": null,
            "first_name": null,
            "last_name": null
        },
        "merchant_no": "500000000008901",
        "app_id": "www.pay.com",
        "create_at": "2026-07-10T09:35:45Z",
        "modify_at": "2026-07-10T09:35:48Z",
        "api_version": null,
        "payment_intent_id": "1012607101735137723",
        "checkout_session_id": null,
        "merchant_order_id": "b4ca2a45-200d-4b9f-9e79-eb23038eb5e2",
        "order_id": "1012607101735137724",
        "invoice_id": null,
        "subscription_id": null,
        "customer_id": null,
        "mandate_id": null,
        "payment_method_id": null,
        "payment_method_details": {
            "type": "google_pay",
            "tokenized_card": {
                "brand": "jcb",
                "country": "US",
                "funding": "credit",
                "last4": "0505",
                "card_bin": "356600",
                "card_category": "consumer"
            },
            "three_ds": {
                "eci_indicator": "07",
                "id": "ecadaa-32113-cacavaada-13141312"
            }
        },
        "return_url": "https://api.webhookinbox.com/i/YhxDlEgC/in/"
    },
    "setup_future_usage": false
}

Quickly create a paymentIntent

Retrieve a PaymentIntent