Skip to content

Payment Methods

Manage bank accounts and cards for recipients.

Add Payment Method

POST /api/v1/recipients/:id/payment-methods

bash
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"
  }'

With Plaid

bash
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 '{
    "plaidProcessorToken": "processor-sandbox-xxxxxx",
    "plaidAccountId": "account-sandbox-xxxxxx",
    "accountHolderName": "John Driver"
  }'

List Payment Methods

GET /api/v1/recipients/:id/payment-methods

Get Payment Method

GET /api/v1/recipients/:id/payment-methods/:pmId

Set Default

PATCH /api/v1/recipients/:id/payment-methods/:pmId

json
{
  "isDefault": true
}

Delete Payment Method

DELETE /api/v1/recipients/:id/payment-methods/:pmId

Verification

Bank accounts require verification before use:

MethodTime
PlaidInstant
Micro-deposits1-3 business days

Check verification status:

json
{
  "status": "verified",
  "verificationMethod": "plaid"
}

Released under the MIT License.