Update clearing rules configuration

Updates the latest configuration for a given scope, organization or program, and returns the new version and checksum. Persistence is asynchronous—the endpoint publishes an event and the immutable snapshot is written afterward, so it isn't guaranteed at response time. The Pending transactions sent event reports clearing events that these rules route to the DLQ, and you can reprocess them with Perform clearing reconciliation. For background on the clearing flow, see Clearing/Base II.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Clearing rules configuration

Clearing rules configuration to create or update for an organization or a program.

config
object
required

Clearing rules to apply. Send only the fields you want to change.

string
required

Organization that owns the configuration

string
length ≤ 500

Note explaining why the configuration changed, stored with the version for auditing

string

Program the configuration applies to. Send it only for a program-scoped configuration.

string
enum

Scope the configuration applies to. When omitted, it's PROGRAM if programId is present and ORG otherwise.

Allowed:
string

User or service account that requested the update.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json