API Reference

Get user's payment links

get

Retrieve a paginated list of payment links for the authenticated user

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for authentication. Get your API key from the KiraPay dashboard.

Query parameters

pageinteger · min: 1Optional

Page number for pagination

Default: 1

limitinteger · min: 1 · max: 100Optional

Number of items per page

Default: 10

Responses

200

Successfully retrieved payment links

application/json

401

Unauthorized - Invalid or missing API key

application/json

500

Internal server error

application/json

get

/link

HTTPcURLJavaScriptPython

GET /api/link HTTP/1.1
Host: kirapay-api.holatech.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "message": "Payment links retrieved successfully",
  "data": {
    "links": [
      {
        "_id": "507f1f77bcf86cd799439011",
        "code": "ABC123",
        "price": 100,
        "tokenOut": {
          "symbol": "USDC",
          "address": "0x...",
          "decimals": 6,
          "chain": "ethereum"
        },
        "receiver": "0x1234567890abcdef1234567890abcdef12345678",
        "user": {
          "_id": "507f1f77bcf86cd799439012",
          "username": "johndoe",
          "address": "0x...",
          "isVerified": true
        },
        "name": "Product Payment",
        "redirectUrl": "https://example.com/success",
        "createdAt": "2024-01-15T10:30:00Z",
        "updatedAt": "2024-01-15T10:30:00Z",
        "url": "https://kirapay.focalfossa.site/pay/ABC123"
      }
    ],
    "total": 25,
    "page": 1,
    "totalPages": 3
  }
}