Skip to main content
The payment links endpoints let you create, list, and retrieve payment links programmatically. A payment link is a shareable URL that directs your customer to a PIK-hosted checkout page. 
POST /payment-links
Creates a new payment link. Request body
​
amount
string
required
The payment amount as a decimal string. Example: "75.00"
​
currency
string
required
The digital asset code to accept. Example: "USDT", "BTC", "ETH"
​
description
string
Optional label or reference for this payment link. Example: "Order #1234"
Example request 
curl -X POST https://api.pik.global/v1/payment-links \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": "75.00",
    "currency": "USDT",
    "description": "Order #1234"
  }'
Response 201 Created 
{
  "id": "pl_abc123xyz",
  "url": "https://pay.pik.global/pl_abc123xyz",
  "amount": "75.00",
  "currency": "USDT",
  "description": "Order #1234",
  "status": "active",
  "created_at": "2024-01-15T10:30:00Z"
}
Response fields
​
id
string
Unique identifier for the payment link. Prefix: pl_
​
url
string
The shareable payment link URL to send to your customer.
​
amount
string
The payment amount.
​
currency
string
The digital asset code.
​
description
string
The optional description provided at creation.
​
status
string
Current status: active, paid, expired, or deactivated.
​
created_at
string
ISO 8601 timestamp of when the link was created.
GET /payment-links
Returns a paginated list of all payment links in your account. Query parameters
​
status
string
Filter by status: active, paid, expired, deactivated
​
limit
integer
Number of results per page. Default: 20. Max: 100
​
offset
integer
Number of results to skip. Default: 0
Example request 
curl -X GET "https://api.pik.global/v1/payment-links?status=active&limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"
Response 200 OK 
{
  "data": [
    {
      "id": "pl_abc123xyz",
      "url": "https://pay.pik.global/pl_abc123xyz",
      "amount": "75.00",
      "currency": "USDT",
      "status": "active",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "total": 1,
  "limit": 10,
  "offset": 0
}

GET /payment-links/{id}
Returns a single payment link by its ID. Path parameters
​
id
string
required
The payment link ID. Example: pl_abc123xyz
Example request 
curl -X GET https://api.pik.global/v1/payment-links/pl_abc123xyz \
  -H "Authorization: Bearer YOUR_API_KEY"
Response 200 OK 
{
  "id": "pl_abc123xyz",
  "url": "https://pay.pik.global/pl_abc123xyz",
  "amount": "75.00",
  "currency": "USDT",
  "description": "Order #1234",
  "status": "paid",
  "created_at": "2024-01-15T10:30:00Z",
  "paid_at": "2024-01-15T10:45:00Z"
}
Error responses
StatusCodeDescription
404not_foundNo payment link found with the given ID