Skip to main content
DELETE
Delete a settlement rule

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

Response

The deleted 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.

Available options:
PENDING_APPROVAL,
ACTIVE,
PAUSED,
DELETED
priority
integer<int32>
required
Example:

1

currency
string
required
Example:

"USD"

match
object[]
required
splits
object[]
required
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.

createdAt
string<date-time>
required
Example:

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

updatedAt
string<date-time>
required
Example:

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