Clearing rules

Get latest clearing rules configuration

Return the latest stored config JSON with metadata for the requested organization

get/v1/rules

Request

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

Query parameters

orgIdstring required

Organization ID

Response

Configuration found

checksumstring

SHA256 checksum of the stored configuration, prefixed with sha256:. Used to detect configuration changes.

descriptionstring

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

orgIdstring

Organization that owns the configuration

scope'ORG' | 'PROGRAM'

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

updated_atstring

Date and time the configuration was updated, in UTC. Format = yyyy-mm-ddThh:mm:ssZ.

updated_bystring

User or service account that requested the update

versioninteger

Version assigned to this configuration, increased by one on every change

Example response

{
  "checksum": "sha256:597ea4051f151bde9c96ea5d1713e69c9a712255146bafc6dc7de22c385004b1",
  "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
  },
  "description": "Enable DLQ routing for key reasons org-wide",
  "orgId": "TN-ddce7e50-0485-49ec-a910-866dff0bfd0f",
  "scope": "ORG",
  "updated_at": "2026-04-15T01:07:13Z",
  "updated_by": "admin@pismo.com",
  "version": 18
}

Changes

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