Getting Started

Welcome to PayStream! This guide will help you make your first payout in minutes.

Prerequisites

• A PayStream account (sign up at paystream.fi)
• An API key from the dashboard
• Node.js 18+ (or your preferred HTTP client)

Quick Start

1. Get Your API Key

1. Log in to the PayStream Dashboard
2. Navigate to Settings → API Keys
3. Click Create API Key
4. Select scopes: write:recipients, write:payments
5. Copy the key (you won't see it again!)

2. Create a Recipient

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

3. 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": "John Driver"
  }'

4. Create a 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": "Weekly payout"
  }'

5. Check Payment Status

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

Next Steps

• Tenant Setup - Configure your tenant settings
• Onboarding - Complete self-service onboarding
• First Payout - Detailed payout walkthrough
• Auto-Funding - Configure automatic balance top-ups
• Payment Rails - Choose the right payment rail
• Webhooks - Set up real-time notifications