Skip to content

Onboarding Guide

This guide walks through setting up a new PayStream tenant from scratch.

Overview

PayStream uses a self-service onboarding wizard. After signing up, tenants complete these steps:

  1. Start - Choose payment provider
  2. Business Info - Legal name, EIN, address
  3. Representatives - Add business owners/officers
  4. Documents - Upload verification documents
  5. Funding Account - Link a bank account for balance funding
  6. Terms of Service - Accept TOS and activate account

Step 1: Sign Up

Create an account at app.paystream.fi. You'll receive a magic-link email to verify your identity.

Step 2: Start Onboarding

From the dashboard, the onboarding wizard guides you through each step. Or via API:

bash
curl -X POST https://api.paystream.fi/api/v1/onboarding/start \
  -H "Authorization: Bearer psk_test_xxx" \
  -H "Content-Type: application/json" \
  -d '{ "provider": "moov" }'

Step 3: Submit Business Information

Provide your legal business details:

bash
curl -X POST https://api.paystream.fi/api/v1/onboarding/business \
  -H "Authorization: Bearer psk_test_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "legalBusinessName": "Acme Logistics LLC",
    "businessType": "llc",
    "ein": "123456789",
    "address": {
      "line1": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "postalCode": "94105",
      "country": "US"
    }
  }'

Step 4: Add Representatives

Add at least one representative (business owner or officer):

bash
curl -X POST https://api.paystream.fi/api/v1/onboarding/persons \
  -H "Authorization: Bearer psk_test_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Jane",
    "lastName": "Doe",
    "title": "CEO",
    "relationship": "representative",
    "dateOfBirth": "1985-03-15",
    "email": "jane@acme.com"
  }'

Connect a bank account for balance funding:

bash
curl -X POST https://api.paystream.fi/api/v1/onboarding/funding-account \
  -H "Authorization: Bearer psk_test_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "routingNumber": "123456789",
    "accountNumber": "4242424242",
    "accountType": "checking"
  }'

Step 6: Accept Terms & Activate

bash
curl -X POST https://api.paystream.fi/api/v1/onboarding/tos \
  -H "Authorization: Bearer psk_test_xxx"

Your account is now active. PayStream will asynchronously provision your account with all configured payment providers.

Check Status

Monitor your onboarding progress at any time:

bash
curl -X GET https://api.paystream.fi/api/v1/onboarding/status \
  -H "Authorization: Bearer psk_test_xxx"

Next Steps

Released under the MIT License.