List settlement rules

The settlement rules the authenticated agent created, oldest first, with their shares. Requires the MANAGE_SETTLEMENT_RULES or VIEW_TRANSACTIONS permission.

GET /agents/me/settlement-rules

List settlement rules

cURL

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

200

{
  "data": [
    {
      "id": "SettlementRule:019542f5-b3e7-1d02-0000-000000000001",
      "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001",
      "name": "Glossier deal",
      "status": "PENDING_APPROVAL",
      "priority": 1,
      "currency": "USD",
      "match": [
        {
          "creditedAccountId": "InternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
          "ruleBasedAccountId": "InternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d001",
          "counterpartyName": {
            "prefix": "GLOSSIER",
            "contains": "glossier inc"
          },
          "receivedAtWalletAddress": "spark1pgssyuuuhnrrdjswal5c3s3rafw9w3y5dd4cjy3duxlf7hjzkp0rqx6dj6mrhu",
          "rail": "ACH"
        }
      ],
      "splits": [
        {
          "share": {
            "type": "PERCENT",
            "basisPoints": 4000,
            "amount": 50000
          },
          "destination": {
            "destinationType": "EXTERNAL_ACCOUNT",
            "externalAccountId": "ExternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123"
          },
          "position": 0
        }
      ],
      "holdSeconds": 0,
      "achHoldSeconds": 86400,
      "limits": {
        "maxAmountPerExecution": 1000000,
        "maxAmountPerDay": 5000000
      },
      "createdAt": "2026-11-06T18:00:00Z",
      "updatedAt": "2026-11-06T18:00:00Z",
      "agentId": "Agent:019542f5-b3e7-1d02-0000-000000000042",
      "agentActionId": "AgentAction:019542f5-b3e7-1d02-0000-000000000099",
      "pendingChangeActionId": "AgentAction:019542f5-b3e7-1d02-0000-000000000098"
    }
  ],
  "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.

Query Parameters

status · enum<string>

Only rules in this status Status of a settlement rule.

Status	Description
PENDING_APPROVAL	Proposed by an agent beyond its policy, waiting for the customer's approval. It fires on nothing.
ACTIVE	Fires on the payments it matches.
PAUSED	Fires on nothing. A payment it would have matched is tried against the customer's next rule.
DELETED	Deleted. It fires on nothing and cannot be changed.

Available options: PENDING_APPROVAL, ACTIVE, PAUSED, DELETED

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 rules matching the filter.