List the executions of a settlement rule

The payments a rule the authenticated agent created fired on, newest first. Requires the MANAGE_SETTLEMENT_RULES or VIEW_TRANSACTIONS permission.

GET /agents/me/settlement-rules/{settlementRuleId}/executions

List the executions of a settlement rule

cURL

curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/agents/me/settlement-rules/{settlementRuleId}/executions \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "SettlementRuleExecution:019542f5-b3e7-1d02-0000-000000000003",
      "settlementRuleId": "SettlementRule:019542f5-b3e7-1d02-0000-000000000001",
      "status": "HELD",
      "incomingTransactionId": "Transaction:019542f5-b3e7-1d02-0000-000000000004",
      "creditedAccountId": "InternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
      "incomingAmount": {
        "amount": 12550,
        "currency": {
          "code": "USD",
          "name": "United States Dollar",
          "symbol": "$",
          "decimals": 2
        }
      },
      "incomingCompletedAt": "2026-11-06T18:00:00Z",
      "firesAt": "2026-11-06T18:00:00Z",
      "createdAt": "2026-11-06T18:00:00Z",
      "updatedAt": "2026-11-06T18:00:02Z",
      "skipReason": "RULE_PAUSED",
      "splitAmount": {
        "amount": 12550,
        "currency": {
          "code": "USD",
          "name": "United States Dollar",
          "symbol": "$",
          "decimals": 2
        }
      },
      "payoutRunId": "PayoutRun:019542f5-b3e7-1d02-0000-000000000005",
      "firstPaymentSentSeconds": 1.8,
      "lastPaymentSentSeconds": 2.6
    }
  ],
  "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

settlementRuleId · string · required

System-generated unique settlement rule identifier

Query Parameters

limit · integer · default: 100

Maximum number of results to return (default 100, 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 executions.