Payments and payouts

Every customer payment takes two steps to reach your bank. First the money settles with Streamlined’s payment partners. Then Streamlined pays it out to your bank in a payout. The API lets you follow a payment through both steps, so you can match each deposit in your bank to the invoices it paid.

​

The model

A payment can pay one invoice, part of one, or several at once. A payment that hasn’t been applied to an invoice yet, such as a deposit, has a null invoice.

​

When a payment settles

How long settling takes depends on how the customer paid: A card payment pays down the invoice as soon as the charge succeeds. A bank debit pays it down once it settles. While a bank debit is settling, the invoice stays Open with is_pending_close: true when the debit covers the balance. See Invoice status and aging.

​

Follow a payment

1. Find payments still settling. GET /transactions?status=pending lists payments the customer has made that haven’t settled yet, such as bank debits.
2. Find settled payments. GET /transactions (the default, status=settled) lists settled transactions. Filter by customer_uuid, customer_group_uuid, date_range, amount_range, or transaction_type.
   curl "https://api.staging.streamlinedpayments.com/api/v1/transactions?customer_uuid=c1f0a92b-4d63-4e88-b0a7-2f9e4c6d1b35&transaction_type=ach,wire" \
     -H "X-App-Id: $STREAMLINED_APP_ID" \
     -H "X-Api-Key: $STREAMLINED_API_KEY"
   
   Each transaction has its amount, fee, and net_amount in cents, the invoice it paid, and its payout_date. A null payout_date means it hasn’t been paid out yet.
3. Find the payout. List payouts returns your payouts, each with its gross total, its fees in disbursement_fee_amount, and disbursement_amount, the net that reached your bank. Get payout details adds the payments inside it, each with its fee and linked_invoice_identifiers.
   curl https://api.staging.streamlinedpayments.com/api/v1/payouts/0f6c3b1a-2d4e-4a8b-9c7d-5e1f2a3b4c6d \
     -H "X-App-Id: $STREAMLINED_APP_ID" \
     -H "X-Api-Key: $STREAMLINED_API_KEY"
   
   {
     "payout": {
       "uuid": "0f6c3b1a-2d4e-4a8b-9c7d-5e1f2a3b4c6d",
       "payout_date": "2026-10-23",
       "status": "paid",
       "total": 730000,
       "disbursement_amount": 727810,
       "institution_name": "Chase",
       "account_number_last_4": "6789",
       "payments": [
         {
           "uuid": "8f2a1c34-9d21-4b7e-a0f5-6c1d8e3b7a92",
           "amount": 480000,
           "fee": 1440,
           "linked_invoice_identifiers": ["W51846"],
           "customer": { "uuid": "c1f0a92b-4d63-4e88-b0a7-2f9e4c6d1b35", "customer_name": "Northwind Traders" },
           "...": "..."
         }
       ],
       "...": "..."
     }
   }
   
   Match disbursement_amount and payout_date to the deposit on your bank statement, then use payments to see which invoices it paid.

​

Pending payouts

A payout is pending from the moment Streamlined creates it until it’s sent to your bank. Then it gets a payout_date and turns paid. List pending payouts returns only the pending ones.

​

Refunds and chargebacks

Refunds and chargebacks are transactions too. Filter for them with transaction_type=refund or transaction_type=chargeback. Money going back to a customer can reduce the payout it lands in, so a payout can be smaller than the payments inside it.