Managing Links

You manage the links you created with the endpoints on this page. Every endpoint is called with the signed request described on Creating Links and requires the matching payment-link:* scope on your key. A key only sees links in its own environment (TEST or LIVE); a link that belongs to another organization or the other environment returns 404. You can do the same from the dashboard.

The Node.js examples use the signedHeaders helper from Creating Links. The cURL examples use the same signing steps as a shell function:

# lunixi-sign.sh — requires OpenSSL 3.0+.
# Usage: source lunixi-sign.sh
#        lunixi_sign GET  "/api/v1/payments/links?limit=25"
#        lunixi_sign POST "/api/v1/payments/links/<id>/pause" "$BODY"
LUNIXI_KEY_ID="mk_test_sk_..."
LUNIXI_KEY_FILE="lunixi-signing.key"
 
lunixi_sign() {
  local method="$1" req_path="$2" body="${3-}"
  DATE=$(date -u +"%Y-%m-%dT%H:%M:%SZ")
  NONCE=$(openssl rand -hex 16)
  if [ -n "$body" ]; then
    DIGEST="SHA-256=$(printf '%s' "$body" | openssl dgst -sha256 -binary | base64)"
    printf '%s\n%s\nX-Date:%s\nX-Nonce:%s\nDigest:%s' "$method" "$req_path" "$DATE" "$NONCE" "$DIGEST" > canonical.txt
  else
    DIGEST=""
    printf '%s\n%s\nX-Date:%s\nX-Nonce:%s' "$method" "$req_path" "$DATE" "$NONCE" > canonical.txt
  fi
  SIGNATURE=$(openssl pkeyutl -sign -inkey "$LUNIXI_KEY_FILE" -rawin -in canonical.txt | base64 | tr -d '\n')
}

Listing

GET /api/v1/payments/links returns your links newest first, in cursor-based pages.

source lunixi-sign.sh
REQ_PATH="/api/v1/payments/links?limit=25&state=ACTIVE,PAUSED"
lunixi_sign GET "$REQ_PATH"
 
curl "https://api-gateway.lunixi.com$REQ_PATH" \
  -H "X-Key-Id: $LUNIXI_KEY_ID" \
  -H "X-Date: $DATE" \
  -H "X-Nonce: $NONCE" \
  -H "X-Signature: $SIGNATURE"

Response

pageInfo sits next to data; the list is in data.items.

{
  "status": "success",
  "code": "SUCCESS",
  "data": {
    "items": [
      {
        "id": "5f0c1d2e-8a4b-4c6d-9e7f-1a2b3c4d5e6f",
        "shortCode": "7KQ2M9XAPT",
        "url": "https://pay.lunixi.com/7KQ2M9XAPT",
        "organizationId": "b1d2c3e4-…",
        "environment": "TEST",
        "state": "ACTIVE",
        "usage": "SINGLE_USE",
        "amountMode": "FIXED",
        "currency": "TRY",
        "amountMinor": 150000,
        "title": "November consulting fee",
        "reference": "INV-2026-0042",
        "tags": [],
        "paidCount": 0,
        "collectedAmountMinor": 0,
        "expiresAt": "2026-10-31T20:59:59.000Z",
        "createdByType": "API_KEY",
        "createdById": "mk_test_sk_…",
        "createdAt": "2026-09-25T09:00:00.000Z",
        "version": 1,
        "rowVersion": 1
      }
    ]
  },
  "pageInfo": { "hasMore": false, "nextCursor": null, "totalCount": null },
  "statusCode": 200,
  "requestId": "req_7f3d9c1a4b2e"
}

A list row is a summary; amountMinor is filled only on FIXED links. Call GET /api/v1/payments/links/:id for the full record.

A single link

GET /api/v1/payments/links/:id returns the link's full record: every field including recipient and prefill, the counters (counters), stock status (availability) and the lock flags. The shape is the same as the create response — see Creating Links › Response.

Updating

PATCH /api/v1/payments/links/:id changes the link's definition and produces a new version (version). Payments already in progress complete with the amount and rules of the version they started on.

Non-amount fields such as the title, description, expiry, buyer fields and attribution fields are not subject to the amount lock. A successful update publishes payment.link.updated.

source lunixi-sign.sh
LINK_ID="5f0c1d2e-8a4b-4c6d-9e7f-1a2b3c4d5e6f"
REQ_PATH="/api/v1/payments/links/$LINK_ID"
BODY='{"expectedRowVersion":1,"title":"November consulting fee (revised)","expiresAt":"2026-11-15T20:59:59.000Z"}'
lunixi_sign PATCH "$REQ_PATH" "$BODY"
 
curl -X PATCH "https://api-gateway.lunixi.com$REQ_PATH" \
  -H "Content-Type: application/json" \
  -H "X-Key-Id: $LUNIXI_KEY_ID" \
  -H "X-Date: $DATE" \
  -H "X-Nonce: $NONCE" \
  -H "Digest: $DIGEST" \
  -H "X-Signature: $SIGNATURE" \
  --data-raw "$BODY"

Pausing, resuming and deactivating

POST /api/v1/payments/links/:id/pause, /resume and /deactivate change the link's state and return the current link.

An invalid transition (e.g. pausing a COMPLETED link) returns 409 payment_link.link.invalid_transition.

source lunixi-sign.sh
REQ_PATH="/api/v1/payments/links/$LINK_ID/pause"
BODY='{"expectedRowVersion":2,"reason":"Stock count"}'
lunixi_sign POST "$REQ_PATH" "$BODY"
 
curl -X POST "https://api-gateway.lunixi.com$REQ_PATH" \
  -H "Content-Type: application/json" \
  -H "X-Key-Id: $LUNIXI_KEY_ID" -H "X-Date: $DATE" -H "X-Nonce: $NONCE" \
  -H "Digest: $DIGEST" -H "X-Signature: $SIGNATURE" \
  --data-raw "$BODY"

Sending

POST /api/v1/payments/links/:id/send sends the link through Lunixi by email or SMS. Idempotency-Key is required: a replay with the same key does not send again and returns the first delivery with replayed: true; the same key with a different body receives 409 payment_link.idempotency.conflict.

{
  "status": "success",
  "code": "SUCCESS",
  "data": {
    "delivery": {
      "id": "0e8a7c55-…",
      "kind": "REQUEST",
      "channel": "EMAIL",
      "recipientMasked": "a***@example.com",
      "state": "QUEUED",
      "failureReason": null,
      "attemptId": null,
      "createdAt": "2026-09-25T09:05:00.000Z",
      "updatedAt": "2026-09-25T09:05:00.000Z"
    },
    "replayed": false
  },
  "statusCode": 200,
  "requestId": "req_…"
}

The delivery is recorded as QUEUED or returns FAILED immediately. Later state changes (SENT, DELIVERED, FAILED) appear in the link's delivery history in the dashboard.

• Sending a taken-down link returns 409 payment_link.link.taken_down.
• Sending also clears the link's access verification lock (verificationLocked: false): if the buyer entered too many wrong codes, send the link again so they can request a new code.
• Reminders (reminders) need no separate call; on a single-use link with recipient set they are sent at the interval you defined.

QR code

GET /api/v1/payments/links/:id/qr returns the QR code containing the link's address (https://pay.lunixi.com/<CODE>) as an image — not JSON.

The response carries Content-Type: image/svg+xml or image/png and Cache-Control: no-store. On failure the standard JSON error envelope is returned. A taken-down link returns 409 payment_link.link.taken_down.

source lunixi-sign.sh
REQ_PATH="/api/v1/payments/links/$LINK_ID/qr?format=png&size=1024"
lunixi_sign GET "$REQ_PATH"
 
curl "https://api-gateway.lunixi.com$REQ_PATH" \
  -H "X-Key-Id: $LUNIXI_KEY_ID" -H "X-Date: $DATE" -H "X-Nonce: $NONCE" \
  -H "X-Signature: $SIGNATURE" \
  -o link-qr.png

Payment attempts

GET /api/v1/payments/links/:id/attempts returns every payment attempt started on the link, newest first. Parameters: limit, cursor and a comma-separated state.

Attempt records contain the buyer's personal data; store them accordingly in your own systems.

Collected payments

GET /api/v1/payments/links/:id/payments returns the link's successful payments with their refund totals. Parameters: limit, cursor.

To refund, use the existing Refunds endpoint with the paymentId. A refund does not change the link's state: a single-use link stays COMPLETED, and sold stock is not added back on a multi-use link.

Errors

For signature errors (401): Creating Links › Errors. On 5xx responses, retry with exponential backoff; if you repeat a send call with the same Idempotency-Key, no second message is sent.

Next steps

• Payment Page — the page the buyer sees and access verification
• Webhooks — link events and order fulfilment
• Pagination — the limit + cursor standard