Guides
Sub-processorsAbout PismoContact us

Clearing rules engine

The Clearing rules engine API provides Pismo clients with a set of external endpoints that allow you to configure which clearing events should be automatically processed by the Pismo platform and which should be routed to the dead letter queue (DLQ). The DLQ is the queue for all pending transactions waiting to be cleared.

With this functionality, you gain more autonomy over exception handling, reduce operational effort required for manual analysis, and increase predictability around what is delivered to the issuer. The Clearing rules engine API offers control and flexibility while managing clearing rules configurations.

The DLQ currently includes the following routing reasons, which may or may not be configurable through the rules engine.

Routing reasonConfigurable?
NOT_REFUNDABLE_AUTHORIZATIONConfigurable (TRUE or FALSE)
NOT_PERMITTED_OPERATIONConfigurable (TRUE or FALSE)
ACCEPTANCE_NOT_FOUNDNot configurable
DIFFERENT_PROCESSING_CODEConfigurable (TRUE or FALSE)
CLEARING_WITH_ZERO_AMOUNTConfigurable (TRUE or FALSE)
INVALID_CARD_MODEConfigurable (TRUE or FALSE)
INVALID_ACCOUNT_STATUSConfigurable (TRUE or FALSE)
MCC_AMOUNT_EXCEEDS_AUTHORIZATIONConfigurable (TRUE or FALSE)
MCC_AUTHORIZATION_NOT_FOUNDConfigurable (List of MCC)
CARD_NOT_FOUNDConfigurable (TRUE or FALSE)
INVALID_JULIAN_DATEConfigurable (TRUE or FALSE)
CANCELLATION_AMOUNT_EXCEEDS_AUTHORIZEDNot configurable
INVALID_SEMANTIC_CANCELLATIONNot configurable
CONCILIATION_DEADLINEConfigurable (integer)
INSTALLMENT_PLAN_VERIFICATIONConfigurable (TRUE or FALSE)
CARD_REGION_RESTRICTIONConfigurable (TRUE or FALSE)

Use the Pending transactions sent event to check Rules engine transactions routed to the DLQ. After receiving these transactions, the issuer can use the Perform clearing reconciliation endpoint to request reprocessing.

Clearing rules engine API endpoints

The Clearing rules engine API provides endpoints to:

  • Create and update DLQ rules
  • Retrieve the active configuration

Endpoint

Description

Update clearing rules engine
PUT /v1/rules

Use this endpoint to create or update the active DLQ rules configuration for a given scope (Org or Program). With it, you can:

  • Configure the rule.
  • Generate the immutable versioned rule set.
  • Update the pointer to the latest version.
  • Return the new version and checksum.

Get latest clearing rules configuration GET /v1/rules

This endpoint returns the latest active configuration for the requested scope (Org or Program), including version metadata.


Updated about 1 hour ago

Did this page help you?