Get or Rotate Claim Link

Returns the existing claim link of a payout, or issues a replacement.

POST/api/payout/{payout_id}/link

Authentication

Scope: payouts:write

Authorization: Bearer <YOUR_PAYOUT_KEY>
Idempotency-Key: <unique key per attempt>

Request Parameters

Field	Type	Description	Required
payout_id	string	Path parameter	✅
rotate	boolean	true issues a replacement link and invalidates the old one	❌

Response Fields

{
  "payout_id": "po_9f3c…",
  "url": "https://…",
  "rotated": false,
  "access_link_expires_at": "2026-10-05T09:14:22Z"
}

Error	HTTP	Meaning
wrong_delivery	409	This is a redirect payout — use sessions
link_unavailable	409	The existing link cannot be shown again. Send {"rotate": true} to issue a new one

Behavior

• Copying never creates a second payout, a second fee, or a later deadline.
• {"rotate": true} invalidates the old link, its verification codes and its sessions together. Use it when a link has gone to the wrong person — not to "refresh" a working one.

Request Samples

# Get the existing link
curl -s -X POST https://luxfin.org/api/payout/po_9f3c1d7b2a8e4c15d0b6a291/link \
  -H "Authorization: Bearer $PAYOUT_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

# The link went to the wrong person — replace it
curl -s -X POST https://luxfin.org/api/payout/po_9f3c1d7b2a8e4c15d0b6a291/link \
  -H "Authorization: Bearer $PAYOUT_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"rotate": true}'