UseePay API
  1. Payment Intents
UseePay API
  • Introduction
  • Product Overview
  • Authentication
  • Errors
  • Changelog
  • Integration
    • Get started with online payments
    • Get started with subscriptions
  • Payment Intents
    • Create a PaymentIntent
      POST
    • Retrieve a PaymentIntent
      GET
    • Update a PaymentIntent
      POST
    • Confirm a PaymentIntent
      POST
    • Cancel a PaymentIntent
      POST
    • Capture a PaymentIntent
      POST
    • List all payment intents
      GET
  • Customers
    • Create a customer
      POST
    • Retrieves a customer
      GET
    • Update a customer
      POST
    • List all customers
      GET
  • Subscriptions
    • Create a subscription
      POST
    • Retrieves a subscription
      GET
    • Update a subscription
      POST
    • List all subscriptions
      GET
    • Cancel a subscription
      POST
  • Invoices
    • Create a invoice
      POST
    • Retrieves a invoice
      GET
    • Update a invoice
      POST
    • List all invoices
      GET
    • Pay a invoice
      POST
  • Payment Methods
    • Create a payment method
    • Retrieves a payment method
    • Update a payment method
    • List all payment methods
  • Mandates
    • Create a mandate
    • Retrieves a mandate
    • Update a mandate
    • List all mandates
  • Refunds
    • Create a refund
    • Retrieves a refund
    • Update a refund
    • List all refunds
  • Webhooks
    • Webhook envents
    • Create a webhook
    • Retrieves a webhook
    • Update a webhook
    • List all webhooks
  • Payment Links
    • Create a payment link
    • Retrieves a payment link
    • Update a payment link
    • List all payment links
  • Embedded Checkout
    • Payment Elements
  • About Testing
    • Test Cards
    • ApplePay&GooglePay
  1. Payment Intents

List all payment intents

GET
/api/v1/payment_intents

Request

Query Params

Header Params

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://openapi1.uat.useepay.com/api/v1/payment_intents?page_num=0&page_size=3&from_created_at=2024-09-29T07:44:50.774Z&customer_id=cus_1JA7UDDQG3800' \
--header 'x-merchant-no: 500000000007245' \
--header 'x-api-key: FUYTIUvjhgfytfuytwiue' \
--header 'x-app-id: www.pay.com'

Responses

🟢200Success
application/json
Body

Example
{
    "items": [
        {
            "id": "ee564cbc7d3a43faa2529ad4f5fcad37",
            "code": null,
            "source": null,
            "message": null,
            "amount": 100.23,
            "currency": "USD",
            "status": "requires_payment_method",
            "customer": {
                "id": null,
                "address": {
                    "country": "US",
                    "city": "New York",
                    "postcode": "100000",
                    "state": "NY",
                    "line1": "Pudong District",
                    "line2": null
                },
                "description": null,
                "name": null,
                "email": "test@useepay.com",
                "phone": null,
                "metadata": null,
                "shipping": null,
                "merchant_no": null,
                "app_id": null,
                "create_at": null,
                "modify_at": null,
                "first_name": "zhang",
                "last_name": "shan",
                "merchant_customer_id": "cust00005"
            },
            "description": "Airwallex - T-shirt",
            "order": {
                "category": "Apparel and accessories",
                "products": [
                    {
                        "id": null,
                        "name": "IPHONE7",
                        "desc": "IPHONE 7",
                        "quantity": 5,
                        "sku": "100004",
                        "type": "physical",
                        "url": "https://example.useepay.com/product/12345",
                        "effective_end_at": "2020-12-31T23:59:59Z",
                        "effective_start_at": "2020-01-01T00:00:00Z",
                        "price": null
                    }
                ],
                "sellers": null,
                "shipping": {
                    "address": {
                        "country": null,
                        "city": "Shanghai",
                        "postcode": "100000",
                        "state": "Shanghai",
                        "line1": "Pudong District",
                        "line2": null
                    },
                    "name": null,
                    "phone": null,
                    "first_name": "John",
                    "last_name": "Doe",
                    "shipping_method": "sameday"
                }
            },
            "metadata": {
                "id": 1
            },
            "confirm": false,
            "merchant_no": "500000000007264",
            "app_id": "www.pay.com",
            "create_at": "2024-10-28T08:18:18Z",
            "modify_at": "2024-10-28T08:18:18Z",
            "decline_code": null,
            "doc_url": null,
            "merchant_order_id": "72934khwqjry09ew805",
            "invoice_id": "inv_1JBQUCEC40000",
            "captured_amount": null,
            "customer_id": "cus_1JA7UDDQG3800",
            "available_payment_method_types": [
                "card",
                "applepay",
                "googlepay"
            ],
            "payment_method_options": {
                "type": "card",
                "card": {
                    "three_ds_action": "FORCE_3DS",
                    "authorization_type": "final_auth",
                    "auto_capture": true
                },
                "klarna": null,
                "wechatpay": null,
                "alipay_hk": null
            },
            "cancellation_reason": null,
            "cancelled_at": null,
            "next_action": null,
            "return_url": "http://www.example.com",
            "client_secret": "635aaff2820fea9eef372d6abc485f96",
            "payment_method_id": null,
            "auto_capture": false,
            "mandate_id": "man_1JBR9QKK80000"
        },
        {
            "id": "450b548bc7bc4627865fa6844e4a931b",
            "code": null,
            "source": null,
            "message": null,
            "amount": 100.23,
            "currency": "USD",
            "status": "requires_payment_method",
            "customer": {
                "id": null,
                "address": {
                    "country": "US",
                    "city": "New York",
                    "postcode": "100000",
                    "state": "NY",
                    "line1": "Pudong District",
                    "line2": null
                },
                "description": null,
                "name": null,
                "email": "test@useepay.com",
                "phone": null,
                "metadata": null,
                "shipping": null,
                "merchant_no": null,
                "app_id": null,
                "create_at": null,
                "modify_at": null,
                "first_name": "zhang",
                "last_name": "shan",
                "merchant_customer_id": "cust00006"
            },
            "description": "Airwallex - T-shirt",
            "order": {
                "category": "Apparel and accessories",
                "products": [
                    {
                        "id": null,
                        "name": "IPHONE7",
                        "desc": "IPHONE 7",
                        "quantity": 5,
                        "sku": "100004",
                        "type": "physical",
                        "url": "https://example.useepay.com/product/12345",
                        "effective_end_at": "2020-12-31T23:59:59Z",
                        "effective_start_at": "2020-01-01T00:00:00Z",
                        "price": null
                    }
                ],
                "sellers": null,
                "shipping": {
                    "address": {
                        "country": null,
                        "city": "Shanghai",
                        "postcode": "100000",
                        "state": "Shanghai",
                        "line1": "Pudong District",
                        "line2": null
                    },
                    "name": null,
                    "phone": null,
                    "first_name": "John",
                    "last_name": "Doe",
                    "shipping_method": "sameday"
                }
            },
            "metadata": {
                "id": 1
            },
            "confirm": false,
            "merchant_no": "500000000007264",
            "app_id": "www.pay.com",
            "create_at": "2024-10-28T08:20:22Z",
            "modify_at": "2024-10-28T08:20:22Z",
            "decline_code": null,
            "doc_url": null,
            "merchant_order_id": "72934khwqjry09ew806",
            "invoice_id": "inv_1JBQUCEC40000",
            "captured_amount": null,
            "customer_id": "cus_1JA7UDDQG3800",
            "available_payment_method_types": [
                "card",
                "applepay",
                "googlepay"
            ],
            "payment_method_options": {
                "type": "card",
                "card": {
                    "three_ds_action": "FORCE_3DS",
                    "authorization_type": "final_auth",
                    "auto_capture": true
                },
                "klarna": null,
                "wechatpay": null,
                "alipay_hk": null
            },
            "cancellation_reason": null,
            "cancelled_at": null,
            "next_action": null,
            "return_url": "http://www.example.com",
            "client_secret": "e81c08fd9d52f1d8a812253186dfe517",
            "payment_method_id": null,
            "auto_capture": false,
            "mandate_id": "man_1JBRA9MQC0000"
        }
    ],
    "has_more": false
}
Modified at 2024-12-27 06:04:14
Previous
Capture a PaymentIntent
Next
Customers
Built with