> ## Documentation Index > Fetch the complete documentation index at: https://docs.interchange.io/llms.txt > Use this file to discover all available pages before exploring further. # Get payout activity > Payout activity for the caller's org (status, period, legal entity, currency, amount, expected/paid date). Currently always `{ rows: [] }` — no payout run has produced an artifact yet. ## OpenAPI ````yaml /v2/storefront-api-v2.yaml get /billing/payout-activity openapi: 3.0.0 info: title: Scope3 Storefront API version: 2.0.0 description: |- REST API for partners to manage storefronts, inventory sources, and billing. ## Authentication All endpoints require a Bearer token in the Authorization header: ``` Authorization: Bearer your-api-key ``` ## Base URL `https://api.interchange.io/api/v2/storefront` ## For AI Agents AI agents can use the MCP endpoint at `/mcp/v2/storefront` with three tools: - `initialize`: Start an MCP session - `api_call`: Make REST API calls - `ask_about_capability`: Learn about API features servers: - url: https://api.interchange.io/api/v2/storefront description: Production server security: [] tags: - name: Account description: Account management, service tokens, and preferences - name: Storefront description: Manage storefront and inventory sources - name: Storefront Agents description: List and manage registered sales, signals, and outcomes agents - name: Storefront Activity description: Audit log of configuration and inventory changes on the storefront - name: Storefront Billing description: Payout bank details and billing configuration for storefronts - name: AI Usage description: Storefront AI token usage visibility by model - name: MCP description: Model Context Protocol endpoints paths: /billing/payout-activity: servers: - url: https://api.interchange.io/api/v2 description: Production server get: tags: - Storefront Billing summary: Get payout activity description: >- Payout activity for the caller's org (status, period, legal entity, currency, amount, expected/paid date). Currently always `{ rows: [] }` — no payout run has produced an artifact yet. operationId: getPayoutActivity responses: '200': description: Get payout activity content: application/json: schema: $ref: '#/components/schemas/PayoutActivityResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearerAuth: [] components: schemas: PayoutActivityResponse: description: >- Payout activity for the caller’s org, newest first. `setup` rows (payout-details changes) appear as soon as they happen; `ledger` rows appear once a payout run has produced at least one artifact. type: object properties: rows: type: array items: $ref: '#/components/schemas/PayoutActivityRow' required: - rows additionalProperties: false ErrorResponse: description: Standard error response type: object properties: data: type: string nullable: true enum: - null error: $ref: '#/components/schemas/ApiError' required: - data - error additionalProperties: false PayoutActivityRow: description: >- One row of payout activity for a seller org, newest first. `kind: "setup"` rows come from the payout-details audit trail (available now); `kind: "ledger"` rows come from payout runs (land once producers exist). oneOf: - $ref: '#/components/schemas/PayoutActivitySetupRow' - $ref: '#/components/schemas/PayoutActivityLedgerRow' type: object discriminator: propertyName: kind mapping: setup: $ref: '#/components/schemas/PayoutActivitySetupRow' ledger: $ref: '#/components/schemas/PayoutActivityLedgerRow' ApiError: description: Structured error object type: object properties: code: description: Machine-readable error code type: string message: description: Human-readable error message type: string field: description: Field path associated with the error type: string details: description: Additional error context type: object additionalProperties: {} required: - code - message additionalProperties: false PayoutActivitySetupRow: description: >- One setup/audit row in payout activity: payout bank details were added, updated, or cleared. Projected from the payout-details audit trail — never carries payout values. type: object properties: kind: type: string enum: - setup reason: description: >- What happened to the payout details: "updated" (details added or edited), "cleared" (details or a payout entity removed), or "changed" (an unrecognized change kind — reserved fallback). Machine-readable so UIs can localize; the sibling `description` field is the English rendering. type: string enum: - updated - cleared - changed description: description: >- Human-readable English description of the setup event (e.g. "Payout details updated" or "Payout details cleared"), derived from `reason`. Never includes payout values — no account numbers, no bank identifiers. UIs should localize from `reason` rather than render this string. type: string actorEmail: description: >- Email of the user who made the change, when known (null for service-token or system-initiated changes) nullable: true type: string occurredAt: description: When the change was made (ISO 8601) type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ required: - kind - reason - description - actorEmail - occurredAt additionalProperties: false PayoutActivityLedgerRow: description: >- One payout-run row for a seller org. No producer exists yet — lands once payout run artifacts / the PUBLISHER_PAYOUT ledger entry type exist to project. type: object properties: kind: type: string enum: - ledger status: description: Status of one payout ledger activity row type: string enum: - pending - paid - failed periodLabel: description: >- Human-readable payout period label (e.g. "June 2026" or "2026-06-01–2026-06-30") type: string entityName: description: >- Legal payout entity this row belongs to (matches `PayoutPayee.entityName` for multi-entity sellers, or the seller org name for the single default payee) type: string currency: description: ISO 4217 currency code example: USD type: string minLength: 3 maxLength: 3 pattern: ^[A-Z]{3}$ amountMinor: description: Payout amount in minor units (e.g. cents for USD) type: integer minimum: -9007199254740991 maximum: 9007199254740991 expectedAt: description: Expected payout date (ISO 8601), when known and not yet paid type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ paidAt: description: When the payout was actually paid out (ISO 8601) type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ statementRef: description: Reference to the payout statement/remittance advice, when available type: string required: - kind - status - periodLabel - entityName - currency - amountMinor additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer description: API key or access token ````