API Reference

Get payment links

get

Retrieve a paginated list of payment links owned by the authenticated user

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for authentication.

Query parameters

statusstringOptional

Filter by link status

Example: active

keystringOptional

Search by link code or name

Example: abc123

from_datestring · date-timeOptional

Filter from date (ISO 8601)

to_datestring · date-timeOptional

Filter to date (ISO 8601)

price_minnumberOptional

Minimum price

Example: 10

price_maxnumberOptional

Maximum price

Example: 1000

pagenumberOptional

Page number

Default: 1

limitnumberOptional

Items per page

Default: 20

Responses

200

Links retrieved successfully

application/json

totalintegerOptional

pageintegerOptional

totalPagesintegerOptional

401

Unauthorized - Invalid API key

application/json

get

/link

HTTPcURLJavaScriptPython

GET /api/link HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "links": [
    {
      "_id": "64abc123def456789012345",
      "code": "abc123xyz7",
      "price": 100,
      "name": "Payment for Order #123",
      "status": "active",
      "type": "single_use",
      "createdAt": "2024-01-15T12:15:00.000Z"
    }
  ],
  "total": 50,
  "page": 1,
  "totalPages": 3
}