List the rows of a payout run

The rows of a run the authenticated agent created, in the order they were submitted.

GET /agents/me/payout-runs/{payoutRunId}/rows

List the rows of a payout run

cURL

curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/agents/me/payout-runs/{payoutRunId}/rows \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "PayoutRunRow:019542f5-b3e7-1d02-0000-000000000002",
      "payoutRunId": "PayoutRun:019542f5-b3e7-1d02-0000-000000000001",
      "clientRowId": "contractor-0042",
      "rowIndex": 41,
      "state": "PENDING",
      "lockedCurrencySide": "SENDING",
      "lockedCurrencyAmount": 125000,
      "destination": {
        "destinationType": "EXTERNAL_ACCOUNT",
        "externalAccountId": "ExternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123"
      },
      "createdAt": "2026-11-04T22:00:00Z",
      "updatedAt": "2026-11-05T02:14:00Z",
      "description": "October invoice",
      "purposeOfPayment": "GIFT",
      "quoteId": "Quote:019542f5-b3e7-1d02-0000-000000000006",
      "transactionId": "Transaction:019542f5-b3e7-1d02-0000-000000000005",
      "claimablePayoutId": "ClaimablePayout:019542f5-b3e7-1d02-0000-000000000007",
      "failureCode": "INSUFFICIENT_FUNDS",
      "failureReason": "Insufficient balance on the source account."
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

Bearer token authentication for agent-scoped endpoints. The token is the accessToken returned when redeeming a device code via POST /agents/device-codes/redeem. Agent credentials are user-scoped: all requests are automatically bound to the agent's associated customer and subject to the agent's policy.

Path Parameters

payoutRunId · string · required

System-generated unique payout run identifier

Query Parameters

state · enum<string>

Only rows in this state State of one row of a payout run.

State	Description
PENDING	Accepted, not started.
PENDING_CLAIM	Addressed to a contact. On a platform's run, held and not paid by the run. On an agent's run, its claimable payout was sent and waits for the recipient to claim it: see claimablePayoutId.
PROCESSING	Its payment has started.
COMPLETED	Its transaction completed.
FAILED	Rejected at validation, refused when paid, or its transaction failed. See failureCode.
SKIPPED	Not paid, because the run was cancelled or another row was rejected under allOrNothing. On an agent's run, failureCode says why: CANCELLED, APPROVAL_REJECTED or APPROVAL_EXPIRED.

Available options: PENDING, PENDING_CLAIM, PROCESSING, COMPLETED, FAILED, SKIPPED

limit · integer · default: 50

Maximum number of results to return (default 50, max 200)

Required range: 1 <= x <= 200

cursor · string

Cursor for pagination (returned from previous request)

Response

200

application/json

Successful operation

data · object[] · required

Show child attributes

hasMore · boolean · required

Indicates if more results are available beyond this page.

nextCursor · string

Cursor to retrieve the next page of results (only present if hasMore is true).

totalCount · integer

Total number of rows matching the filter.