Payout Embed

Let a recipient claim a payout from a balance you hold on Blitz — without asking them to create a Blitz account first.

How it works

  • Your backend creates a session for an amount and gets back an unguessable claim link.
  • You send that link to your recipient, or embed it directly on your own site in an iframe.
  • The recipient verifies a phone number or email with a one-time code, picks a payout rail (PayPal or a bank/card via Stripe), and confirms — no account, no password.
  • Blitz sends the funds and notifies you by webhook.

Create a session

POST/api/commerce/payout-embed/sessions

Requires an API key with the payout_embed:write scope. Reserves the amount from your available balance immediately.

create-session.sh
curl -X POST https://api.nest.useblitz.co/api/commerce/payout-embed/sessions \
  -H "Authorization: Bearer bk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "amountMinorUnits": "2500",
    "recipientReference": "your-internal-user-id",
    "idempotencyKey": "unique-per-payout"
  }'

Response:

response.json
{
  "id": "...",
  "payoutId": "pay_...",
  "amountMinorUnits": "2500",
  "currency": "USD",
  "status": "CLAIM_PENDING",
  "claimToken": "..."
}
  • recipientReference — your own opaque identifier for who this is for. Never used to identify anyone — the recipient verifies their own contact at claim time.
  • expiresAt (optional) — defaults to 7 days out. An unclaimed session past this point can no longer be claimed; cancel it to get the reservation back sooner.

Embed the claim link

Append ?embed=true to the returned claim link to render it chrome-free inside an iframe on your own site. Without that parameter it renders as a normal full page — safe to send directly by email or SMS instead.

embed.html
<iframe
  src="https://useblitz.co/payout-embed/{claimToken}?embed=true"
  width="420"
  height="640"
  style="border: 0"
></iframe>

Cancel a session

POST/api/commerce/payout-embed/sessions/:id/cancel

Session-authenticated (your Blitz login, not the API key) — manage sessions from your Developer Portal. Releases the reserved balance if still unclaimed.

Rails available to the recipient depend on what's configured on your account — PayPal is always available; bank/card via Stripe requires the recipient to complete a short Stripe-hosted onboarding step inside the widget the first time they claim.