UseePay API
  1. Payment Links
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
    • Retrieves a invoice
    • Update a invoice
    • List all invoices
    • Pay a invoice
  • 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
      POST
    • Retrieves a payment link
      GET
    • Update a payment link
      POST
    • List all payment links
      GET
  • Embedded Checkout
    • Payment Elements
  • About Testing
    • Test Cards
    • ApplePay&GooglePay
  1. Payment Links

Retrieves a payment link

GET
/api/v1/payment_links/{{payment-link-id}}

Request

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_links/plk_1JK617TE81400' \
--header 'x-merchant-no: 500000000007245' \
--header 'x-api-key: FUYTIUvjhgfytfuytwiue' \
--header 'x-app-id: www.pay.com'

Responses

🟢200Success
application/json
Body

Example
{
    "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": "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": 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:50:06Z",
    "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
    }
}
Modified at 2024-12-27 06:03:17
Previous
Create a payment link
Next
Update a payment link
Built with