Quickstart
Send your first payout from the sandbox in a few minutes.
This walkthrough uses the sandbox, where no real money moves and payouts settle instantly.
1. Get an API key
- Sign up at sandbox.talentir.com and create a team.
- Go to Dashboard → Integrations → API keys and create a key.
- Send it as a Bearer token on every request.
export TALENTIR_API_KEY="tal_..."
export BASE_URL="https://sandbox.talentir.com/api/v1"2. Create a payout
curl -X POST "$BASE_URL/payout" \
-H "Authorization: Bearer $TALENTIR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"description": "Payment for YouTube channel campaign",
"creatorHandle": "@mrbeast",
"verificationMethod": "youtube-channel",
"payoutAmount": "100.00",
"currency": "EUR",
"customId": "campaign-42"
}'The response contains the payout id, its status (created), and an action field that tells you whether the payout was created or updated (payouts are upserted by customId — see Idempotency).
3. Send the recipient a claim link
Mint a hosted session URL and send it to the person being paid:
curl -X POST "$BASE_URL/session/payout" \
-H "Authorization: Bearer $TALENTIR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"payoutId": "<payout id from step 2>",
"redirectUrl": "https://yourapp.com/done"
}'The returned url is an opaque Talentir-hosted claim screen. The recipient signs in or signs up with their own email and claims the payout. Treat the URL as opaque and do not parse it.
4. Check the status
curl "$BASE_URL/payout/<payout id>" \
-H "Authorization: Bearer $TALENTIR_API_KEY"In the sandbox, a claimed payout settles instantly, so you can watch it move through the payout lifecycle right away. For production integrations, subscribe to webhooks instead of polling.
Next steps
- Approve and execute payouts — payouts start out pending; someone or something must approve them.
- OAuth 2.1 with PKCE — for platform integrations that act on behalf of connected customer teams.
- Set up webhooks — real-time payout status notifications.