Payments Link

Get detailed information about a specific payments link, including its title, desc, amount type, charge type, payment methods, price, supported chains, status and more.

---

API

GET /api/payment/payee

Example:

GET https://coindpay.xyz/api/payment/payee?id=0GRW2_vl4SWHHAdKj-blu

Query Params

Name	Type	Required	Example	Description
id	string*	Yes	b-y_ngimTqIEj2q1HQAIj	Unique identifier for the payments link

* Required

Response

✅ 200 - Success

{
  "ok": true,
  "data": {
    "id": "0GRW2_vl4SWHHAdKj-blu",
    "uuid": "user_abc123",
    "title": "Buy Me a Coffee",
    "desc": "Support my work with a coffee ☕",
    "price": 3.5,
    "amountType": 1,
    "maxAmount": 50000,
    "payType": [ "fiat", "crypto"],
    "chargeType": 1,
    "chains": [ "solana", "ethereum"],
    "images": [ 
      "https://cdn.coindpay.xyz/xx1.png",
      "https://cdn.coindpay.xyz/xx2.png" 
    ],
    "theme": 2,
    "copyright": { 
      "logo": "https://cdn.coindpay.xyz/steady/brand/logo/dark.png" 
    },
    "status": 1,
    "createdAt": "2025-06-20T12:34:56Z",
    "updatedAt": "2025-10-09T12:34:56Z",
  }
}

---

Field Descriptions

Field	Type	Description
id	string*	Unique identifier of the payments link
uuid	string*	Linked user uuid
title	string*	Title of the payments
desc	string?	Description of the payments
price	float?	Fixed payments amount (used if amountType = 1)
amountType	int*	Type of amount: 1 = fixed 2 = variable (up to maxAmount)
maxAmount	float?	Maximum amount if using variable pricing Maximum: 50000
chains	string[]?	Supported chains (e.g., solana, ethereum) svm: Not include chainId evm：Includes chainId
images	string[]?	Cover image(s) for display
theme	int*	Theme/style variant 0/1/2/3/4/5
copyright	object?	Custom brand logo
status	int*	Status: @default(1) 1 = online -1 = offline 0 = deleted
chargeType	int*	Charge Type @default(1) 1 = Single payment Charge a one-time fee 2 = Subscription Charge an ongoing fee
subscribeType	string?	Subscribe Type ✅ chargeType=2 @default('monthly') monthly weekly
payType	string[]*	Payment Methods Multi-select fiat crypto
createdAt	string	ISO 8601 creation timestamp

---

❌ Error Responses

404 - Not Found

{
  "ok": false,
  "message": "Payment link not found ˙◠˙"
}

---

cURL Request

curl "https://coindpay.xyz/api/payment/payee?id=0GRW2_vl4SWHHAdKj-blu"

---

Notes

• If amountType = 2, allow users to enter an amount up to maxAmount.

• The uuid field can be used to query the owner's other links or rewards.

• Use the status value to determine whether to display the link.

• Please use real payment id and other params to integrate and test the API.