Payments Link

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


API

GET /api/payment/payee

Example:

GET https://coindpay.xyz/api/payment/payee?id=b-y_ngimTqIEj2q1HQAIj

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": "b-y_ngimTqIEj2q1HQAIj",
    "uuid": "user_abc123",
    "title": "Buy Me a Coffee",
    "desc": "Support my work with a coffee ☕",
    "price": 3.5,
    "amountType": 1,
    "maxAmount": null,
    "chains": ["solana", "ethereum"],
    "images": ["https://cdn.coindpay.xyz/cover.png"],
    "theme": 2,
    "copyright": true,
    "status": 1,
    "createdAt": "2025-06-20T12: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

boolean

Whether the payments link content is copyright protected(@CoindPay)

status

int

Status: 1 = online -1 = offline 0 = deleted

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=b-y_ngimTqIEj2q1HQAIj"

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.

Last updated