Get payout activity

GET /api/v2/billing/payout-activity Returns the payout activity for your organization — one row per payout run, with its status, period, the legal payout entity it was paid to, currency, amount, and the expected or actual payout date. It powers the Payout activity section at the top of the Payouts tab on the org Billing page.

Payout runs are executed manually by the Interchange finance team (see Billing overview). This endpoint currently always returns { "rows": [] } — it will start populating once the first payout run produces an artifact for your organization. Nothing is fabricated: an empty list means no payout has run yet, not that the endpoint is broken.

Request

curl

curl "https://api.interchange.io/api/v2/billing/payout-activity" \
  -H "Authorization: Bearer $SCOPE3_API_KEY"

Parameters

Parameter	Type	Notes
`targetCustomerId`	integer (query, optional)	Read a child account’s payout activity — parent-to-child only, validated against the organization hierarchy

From an agent (MCP)

The get_payout_activity operation on the storefront api_call tool returns the same rows.

Response

{
  "rows": []
}

Once payout runs exist, each row looks like:

{
  "rows": [
    {
      "status": "paid",
      "periodLabel": "June 2026",
      "entityName": "Acme Media Ltd",
      "currency": "USD",
      "amountMinor": 482300,
      "paidAt": "2026-07-05T00:00:00.000Z",
      "statementRef": "STMT-2026-06-0042"
    }
  ]
}

Field	Type	Notes
`status`	string	`pending`, `paid`, or `failed`
`periodLabel`	string	Human-readable payout period (e.g. “June 2026”)
`entityName`	string	The legal payout entity this row was paid to — matches payout payees for multi-entity sellers, or your organization name for the single default payee
`currency`	string	ISO 4217 payout currency
`amountMinor`	integer	Amount in minor units (e.g. cents for USD)
`expectedAt`	string \| absent	Expected payout date (ISO 8601), when known and not yet paid
`paidAt`	string \| absent	When the payout actually landed (ISO 8601)
`statementRef`	string \| absent	Reference to the payout statement/remittance advice, when available

Errors

401 UNAUTHORIZED — missing or invalid bearer token.
403 ACCESS_DENIED — targetCustomerId isn’t a child of the requesting organization.

See Errors for the full error contract.

Get billing config

Fees, currency, net days, masked payout details

Billing overview

How payouts work

Get billing config List billing accounts

⌘I

Getting Started

Operating Your Storefront

Inventory Sources

Real-Time Targeting (TMP)

Approvals & Reviews

Buyer Onboarding

Demand & Signals

Proposals & Agents

Buyer Routing

Analytics & Activity

Billing

Account

Request

Parameters

From an agent (MCP)

Response

Errors

Get billing config

Billing overview

​Request

​Parameters

​From an agent (MCP)

​Response

​Errors

​Related

Get billing config

Billing overview

Request

Parameters

From an agent (MCP)

Response

Errors

Related