First Payout

This guide walks through creating your first payout end-to-end.

Prerequisites

• API key with write:recipients and write:payments scopes
• Balance funded with at least the payment amount

Step 1: Create Recipient

curl -X POST https://api.paystream.fi/api/v1/recipients \
  -H "Authorization: Bearer psk_test_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Jane Smith",
    "email": "jane@example.com"
  }'

Save the id from the response (e.g., rec_abc123).

Step 2: Add Payment Method

curl -X POST https://api.paystream.fi/api/v1/recipients/rec_abc123/payment-methods \
  -H "Authorization: Bearer psk_test_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "bank_account",
    "routingNumber": "123456789",
    "accountNumber": "4242424242",
    "accountType": "checking",
    "holderName": "Jane Smith"
  }'

Step 3: Create Payment

curl -X POST https://api.paystream.fi/api/v1/payments \
  -H "Authorization: Bearer psk_test_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "recipientId": "rec_abc123",
    "amount": 50000,
    "currency": "usd",
    "description": "First payout"
  }'

Step 4: Monitor Status

curl -X GET https://api.paystream.fi/api/v1/payments/pay_xyz789 \
  -H "Authorization: Bearer psk_test_xxx"

Or set up a webhook for automatic notifications.

Timeline

Rail	Expected Completion
Standard ACH	2-3 business days
Same-Day ACH	Same business day
RTP	~30 seconds

Next Steps

• Batch Processing - Process multiple payments at once
• Error Handling - Handle failed payments