PIpismo
Clearing rules

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.

put/v1/rules

Request

  • Base URL
    https://sandbox.pismolabs.io/clearing-rules
  • URL
    https://sandbox.pismolabs.io/clearing-rules/v1/rules
  • Auth
    HTTP bearer

Request body

orgIdstring required

Organization that owns the configuration

descriptionstring

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

programIdstring

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

scope'ORG' | 'PROGRAM'

Level a clearing rules configuration applies to: ORG covers every program in the organization, PROGRAM covers a single program

updated_bystring

User or service account that requested the update.

Example request

{
  "config": {
    "account_status": true,
    "card_not_found": true,
    "card_region_restriction": true,
    "conciliation_deadline": 30,
    "different_processing_code": true,
    "installment_plan_verification": true,
    "invalid_julian_date": true,
    "mcc_amount_exceeds_authorization": {
      "mcc": [
        "5411"
      ],
      "percentage": 10
    },
    "mcc_authorization_not_found": [
      "5812"
    ],
    "not_refundable_authorization": true
  },
  "orgId": "TN-ddce7e50-0485-49ec-a910-866dff0bfd0f",
  "description": "Enable DLQ routing for key reasons org-wide",
  "programId": "prog456",
  "scope": "ORG",
  "updated_by": "admin@pismo.com"
}

Response

Configuration updated or no changes detected

OR

Example response

{
  "checksum": "sha256:597ea4051f151bde9c96ea5d1713e69c9a712255146bafc6dc7de22c385004b1",
  "orgId": "TN-ddce7e50-0485-49ec-a910-866dff0bfd0f",
  "programId": "prog456",
  "scope": "ORG",
  "updated_at": "2026-02-20T10:30:00Z",
  "updated_by": "admin@pismo.com",
  "version": 18
}

Changes

No recorded changes to this operation across all 1 revision of this API.