Skip to main content
GET /api/v2/storefront/billing/payouts Returns payouts from your connected Stripe account to your bank, newest first. Cursor-paginated: pass the last item’s id as starting_after to fetch the next page. Use this to reconcile settled funds against your bank deposits.

​
Request

curl "https://api.interchange.io/api/v2/storefront/billing/payouts?limit=25" \
  -H "Authorization: Bearer $SCOPE3_API_KEY"

​
Parameters

FieldTypeRequiredNotes
limitintegerNoQuery param. Maximum results, 1–100. Default 25
starting_afterstringNoQuery param. Cursor — the id of the last item from the previous page
targetCustomerIdnumberNoQuery param. Parent customers read a child account’s payouts

​
Response

[
  {
    "id": "po_1Abc2DefGhiJklMn",
    "amount": 4250000,
    "currency": "usd",
    "created": 1748520000,
    "arrivalDate": 1748692800,
    "status": "paid",
    "method": "standard",
    "description": "STRIPE PAYOUT"
  }
]
amount is in the currency’s smallest unit (cents for usd). created and arrivalDate are Unix timestamps (seconds) — arrivalDate is when funds are expected to land in the bank. This endpoint is cursor-paginated: when meta.hasMore is true, pass meta.cursor as starting_after to get the next page; see Pagination.

​
Errors

  • 400 VALIDATION_ERROR — limit outside 1–100, no Stripe account provisioned, or Stripe is not configured on the server.
See Errors for the full error contract.

Billing tasks

All billing operations

Get balance transactions

The underlying ledger entries

Get account status

Confirm payouts are enabled

Billing overview

Stripe Connect concepts