List all payment links

GET

/api/v1/payment_links

Request

Query Params

Header Params

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://openapi1.uat.useepay.com/api/v1/payment_links?page_num=0&page_size=3' \
--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": "plk_1JK5UKMV02400",
            "code": null,
            "source": null,
            "message": null,
            "order": {
                "category": "Apparel and accessories",
                "products": [
                    {
                        "id": null,
                        "name": "IPHONE7",
                        "code": "3414314111",
                        "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"
                }
            },
            "amount": 12.34,
            "currency": "USD",
            "reusable": false,
            "title": "title1",
            "description": "description1",
            "metadata": {},
            "reference": "reference",
            "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": "cust00002"
            },
            "status": null,
            "url": null,
            "merchant_no": "500000000007245",
            "app_id": "www.pay.com",
            "create_at": "2024-11-23T05:38:44Z",
            "modify_at": "2024-11-23T05:38:44Z",
            "decline_code": null,
            "doc_url": null,
            "customer_id": "cus_1JA7UDDQG3800",
            "supported_currencies": [
                "USD",
                "EUR"
            ],
            "expires_at": null,
            "collectable_options": {
                "message": true,
                "reference": false,
                "phone_number": false,
                "shipping_address": false,
                "billing_address": false
            }
        },
        {
            "id": "plk_1JK617TE81400",
            "code": null,
            "source": null,
            "message": null,
            "order": {
                "category": "Apparel and accessories",
                "products": [
                    {
                        "id": null,
                        "name": "IPHONE7",
                        "code": "3414314111",
                        "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"
                }
            },
            "amount": 12.34,
            "currency": "USD",
            "reusable": false,
            "title": "title2",
            "description": "description2",
            "metadata": {},
            "reference": "reference",
            "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": null
            },
            "status": "unpaid",
            "url": null,
            "merchant_no": "500000000007245",
            "app_id": "www.pay.com",
            "create_at": "2024-11-23T05:50:06Z",
            "modify_at": "2024-11-23T05:52:24Z",
            "decline_code": null,
            "doc_url": null,
            "customer_id": "cus_1JA7UDDQG3800",
            "supported_currencies": [
                "USD",
                "EUR"
            ],
            "expires_at": null,
            "collectable_options": {
                "message": true,
                "reference": false,
                "phone_number": false,
                "shipping_address": false,
                "billing_address": false
            }
        }
    ],
    "has_more": false
}

Modified at 2024-12-27 06:04:26

Update a payment link

Payment Elements