Update a settlement rule

Change the fields sent and leave the rest as they are. splits replaces every share, checked as on create. limits replaces both limits, so a limit left out of it is removed, and null removes both. A change applies to the payments whose execution has not yet fired, held ones included.

Requires an API token with the UMA_TRANSACT permission.

PATCH /settlement-rules/{settlementRuleId}

Update a settlement rule

cURL

curl --request PATCH \
  --url https://api.lightspark.com/grid/2025-10-13/settlement-rules/{settlementRuleId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Glossier deal",
  "priority": 2,
  "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": {
        "basisPoints": 4000,
        "amount": 50000
      },
      "destination": {
        "destinationType": "EXTERNAL_ACCOUNT",
        "externalAccountId": "ExternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123"
      }
    }
  ],
  "holdSeconds": 0,
  "achHoldSeconds": 0,
  "limits": {
    "maxAmountPerExecution": 1000000,
    "maxAmountPerDay": 5000000
  }
}
'

200

{
  "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"
}

Authorizations

Authorization · string · header · required

API token authentication using format <api token id>:<api client secret>

Path Parameters

settlementRuleId · string · required

System-generated unique settlement rule identifier

Body

application/json

The fields to change. A field left out is unchanged.

name · string

Required string length: 1 - 255

Example:

"Glossier deal"

status · enum<string>

ACTIVE or PAUSED.

Available options: PENDING_APPROVAL, ACTIVE, PAUSED, DELETED

priority · integer<int32>

Required range: 0 <= x <= 2147483647

Example:

2

match · object[]

Required array length: 1 - 20 elements

Show child attributes

splits · object[]

Every share, replacing the current ones. At most 20.

Minimum array length: 1

Show child attributes

holdSeconds · integer

Required range: 0 <= x <= 86400

Example:

0

achHoldSeconds · integer

Required range: 0 <= x <= 86400

Example:

0

limits · object | null

Both limits, replacing the current ones. A limit left out is removed; null removes both.

Show child attributes

Response

200

application/json

The updated rule

id · string · required

System-generated unique settlement rule identifier

Example:

"SettlementRule:019542f5-b3e7-1d02-0000-000000000001"

customerId · string · required

Example:

"Customer:019542f5-b3e7-1d02-0000-000000000001"

name · string · required

Example:

"Glossier deal"

status · enum<string> · required

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

priority · integer<int32> · required

Example:

1

currency · string · required

Example:

"USD"

match · object[] · required

Show child attributes

splits · object[] · required

Show child attributes

holdSeconds · integer · required

Example:

0

achHoldSeconds · integer · required

Example:

86400

limits · object · required

Caps on what the rule pays, in the smallest unit of its currency. An execution that would go over a cap is skipped with LIMIT_EXCEEDED, and the customer keeps the payment.

Show child attributes

createdAt · string<date-time> · required

Example:

"2026-11-06T18:00:00Z"

updatedAt · string<date-time> · required

Example:

"2026-11-06T18:00:00Z"

agentId · string

The agent that created the rule through the agent API. Absent for a rule created with an API token.

Example:

"Agent:019542f5-b3e7-1d02-0000-000000000042"

agentActionId · string

The CREATE_SETTLEMENT_RULE agent action awaiting the customer's approval of the rule. Present while the rule is PENDING_APPROVAL.

Example:

"AgentAction:019542f5-b3e7-1d02-0000-000000000099"

pendingChangeActionId · string

The UPDATE_SETTLEMENT_RULE agent action holding a change to the rule's match, shares or limits until the customer approves it. Present while the change waits; the rule keeps its current terms until then.

Example:

"AgentAction:019542f5-b3e7-1d02-0000-000000000098"