Guide
Pay people with payout links
Send money without knowing the wallet address.
What a payout link is
A payout link pays someone without you knowing their wallet address. You fund the link from your balance and send it to them; they open it, choose a coin, network and address, and get paid on chain. Useful for affiliate and creator payouts, prizes, freelancers and goodwill credits.
- From $1.00 to $5,000 per link.
- The amount is held from your available balance as soon as the link is created.
- The recipient pays the payout and network fees out of what they receive.
- Unclaimed links expire after 7 days by default (1–90) and the money comes back to you.
1. Create the link
Payout links move money out, so they use your withdrawal key (wk_live_…, from Dashboard → Developers, shown once). Pass email and we email the link to the recipient.
curl -X POST https://cryptopayr.com/api/v1/payout-link/create \
-H "Authorization: Bearer wk_live_xxxxxxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: march-affiliate-1024" \
-d '{"amount":150,"email":"[email protected]","note":"March commission — thanks!"}'// Not wrapped by the SDK yet: use the low-level request() with the withdrawal key.
$link = $cp->request('POST', 'api/v1/payout-link/create', [
'amount' => 150,
'email' => '[email protected]',
'note' => 'March commission — thanks!',
], \CryptoPayr\Http::AUTH_WITHDRAWAL, 'march-affiliate-1024');
echo $link['url']; // shown once// Not wrapped by the SDK yet: use the low-level request() with the withdrawal key.
const link = await cp.request(
'POST',
'api/v1/payout-link/create',
{ amount: 150, email: '[email protected]', note: 'March commission — thanks!' },
'withdrawal',
'march-affiliate-1024'
);
console.log(link.url); // shown once# Not wrapped by the SDK yet: use the low-level request() with the withdrawal key.
from cryptopayr.http import AUTH_WITHDRAWAL
link = cp.request(
"POST", "api/v1/payout-link/create",
{"amount": 150, "email": "[email protected]", "note": "March commission — thanks!"},
auth=AUTH_WITHDRAWAL,
idempotency_key="march-affiliate-1024",
)
print(link["url"]) # shown oncepayout-link/resend issues a new one and the old URL stops working. Add "require_email_code": true so the recipient must also enter a code sent to their email, in case the link is forwarded.2. Follow it
A link goes ACTIVE → CLAIMING → PROCESSING → COMPLETED. It can also end CANCELLED or EXPIRED (money back to you), or sit in HELD while our team confirms an unclear send. If a send fails, the link goes back to ACTIVE so the recipient can try again.
We send a webhook to your default webhook URL at each step: PAYOUT_LINK_CLAIMED, PAYOUT_LINK_COMPLETED, PAYOUT_LINK_FAILED, PAYOUT_LINK_CANCELLED and PAYOUT_LINK_EXPIRED. The event name is in the body's event field and the X-CryptoPayr-Event header. See the event reference for the payload.
Or check it yourself with GET /api/v1/payout-link/lookup?id=plk_… and list them with GET /api/v1/payout-links (your secret key).
3. Cancel if you need to
Until the recipient claims it, you can cancel a link and the amount goes straight back to your balance:
curl -X POST https://cryptopayr.com/api/v1/payout-link/cancel \
-H "Authorization: Bearer wk_live_xxxxxxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"id":"plk_8Kf3pQ9xR2mWvT1nZpLc"}'
Once it's claimed, cancelling answers 409: the money is on its way.